Partner Portal

Get partner portal MDF requests

Get the market development funds requests filed under the authenticated partner organization, newest first.

POST/api/partnerportal/getMdfRequests

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: partner-api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

Body

application/json · object

Request object for getting the market development funds requests belonging to the authenticated partner organization.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partnerportal/getMdfRequests' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/partnerportal/getMdfRequests"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/partnerportal/getMdfRequests', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partnerportal/getMdfRequests"))
            .header("x-auth-scheme", "partner-api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "requests": [
    {
      "activityCost": 0,
      "activityDescription": "<string>",
      "activityEndDate": "<string>",
      "activityStartDate": "<string>",
      "activityType": "<string>",
      "amountRequested": 0,
      "assignedReviewerName": "<string>",
      "budgetEndDate": "<string>",
      "budgetName": "<string>",
      "budgetStartDate": "<string>",
      "city": "<string>",
      "countryCode": "<string>",
      "createdDate": "<string>",
      "mdfAllocationId": "<string>",
      "mdfRequestId": "<string>",
      "name": "<string>",
      "partnerContactName": "<string>",
      "postalCode": "<string>",
      "rejectionDetail": "<string>",
      "rejectionReason": "<string>",
      "requestApprovalDate": "<string>",
      "requestSubmittedDate": "<string>",
      "requestTitle": "<string>",
      "stage": "<string>",
      "stateCode": "<string>",
      "street": "<string>"
    }
  ]
}

Response

200 OK

application/json · object

Response object containing the market development funds requests belonging to the authenticated partner organization.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

requestsobject[] | null

List of requests filed under the partner organization, newest first

Show child attributes

activityCostnumber | null

Total cost of the marketing activity

activityDescriptionstring | null

Description of the marketing activity the funds are requested for

activityEndDatestring | null

Last day of the marketing activity, in yyyy-MM-dd format

activityStartDatestring | null

First day of the marketing activity, in yyyy-MM-dd format

activityTypestring | null

Type of the marketing activity

amountRequestednumber | null

Amount of funding requested

assignedReviewerNamestring | null

Name of the Rhombus reviewer assigned to the request

budgetEndDatestring | null

Last day of the budget period the request draws on, in yyyy-MM-dd format

budgetNamestring | null

Name of the budget the request draws on

budgetStartDatestring | null

First day of the budget period the request draws on, in yyyy-MM-dd format

citystring | null

City where the marketing activity takes place

countryCodestring | null

ISO 3166-1 alpha-2 code of the country where the marketing activity takes place

createdDatestring | null

Date and time the request was created, as the raw Salesforce datetime (for example 2026-01-15T18:30:00.000+0000)

mdfAllocationIdstring | null

Identifier of the Salesforce MDF allocation the request draws on

mdfRequestIdstring | null

Identifier of the Salesforce MDF request

namestring | null

Salesforce generated number of the request

partnerContactNamestring | null

Name of the partner contact who filed the request

postalCodestring | null

Postal code where the marketing activity takes place

rejectionDetailstring | null

Further detail on why the request was rejected

rejectionReasonstring | null

Reason the request was rejected

requestApprovalDatestring | null

When the request was approved, as the raw Salesforce value

requestSubmittedDatestring | null

Date and time the request was submitted, as the raw Salesforce datetime (for example 2026-01-15T18:30:00.000+0000)

requestTitlestring | null

Title of the request

stagestring | null

Current stage of the request; claims can only be filed against an Approved request

stateCodestring | null

ISO code of the state or province where the marketing activity takes place

streetstring | null

Street address where the marketing activity takes place

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND, SELF_PROVISIONING_DISABLED, SKU_NOT_ALLOWED, QUANTITY_INVALID, AUTO_RENEW_REQUIRED, PROVISION_CAP_EXCEEDED, ACKNOWLEDGEMENT_REQUIRED, SIGNATURE_REQUIRED, APEX_VALIDATION, SKU_NOT_IN_PRICEBOOK.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT, NOT_VERIFIED_MSP, ORDER_NOT_YOURS.
429 Too Many Requests. errorCode is one of: RATE_LIMITED, QUOTE_RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE, SALESFORCE_UNAVAILABLE.