Partner Portal

Create partner portal MDF request

File a market development funds request for the authenticated partner organization. The request is attached to the organization's open allocation whose budget period covers today, and is rejected when no such allocation exists. The submitting partner is derived server-side from the authenticated session. Not idempotent: retrying creates another request.

POST/api/partnerportal/createMdfRequest

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 write 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 filing a market development funds request on behalf of the authenticated partner organization.

activityCostnumber | nullbody

Total cost of the marketing activity; must be greater than zero when present

activityDescriptionstring | nullbody

Description of the marketing activity the funds are requested for

activityEndDatestring | nullbodyrequired

Last day of the marketing activity, in yyyy-MM-dd format; not before activityStartDate

activityStartDatestring | nullbodyrequired

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

activityTypestring | nullbodyrequired

Type of the marketing activity

amountRequestednumber | nullbodyrequired

Amount of funding requested; must be greater than zero

citystring | nullbody

City where the marketing activity takes place

countryCodestring | nullbody

ISO 3166-1 alpha-2 code of the country where the marketing activity takes place (for example US)

postalCodestring | nullbody

Postal code where the marketing activity takes place

requestTitlestring | nullbodyrequired

Title of the request

stateCodestring | nullbody

ISO code of the state or province where the marketing activity takes place (for example CA); requires countryCode, since Salesforce rejects a state without a country

streetstring | nullbody

Street address where the marketing activity takes place

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partnerportal/createMdfRequest' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "activityCost": 0,
    "activityDescription": "<string>",
    "activityEndDate": "<string>",
    "activityStartDate": "<string>",
    "activityType": "<string>",
    "amountRequested": 0,
    "city": "<string>",
    "countryCode": "<string>",
    "postalCode": "<string>",
    "requestTitle": "<string>",
    "stateCode": "<string>",
    "street": "<string>"
  }'

import requests

url = "https://api2.rhombussystems.com/api/partnerportal/createMdfRequest"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "activityCost": 0,
    "activityDescription": "<string>",
    "activityEndDate": "<string>",
    "activityStartDate": "<string>",
    "activityType": "<string>",
    "amountRequested": 0,
    "city": "<string>",
    "countryCode": "<string>",
    "postalCode": "<string>",
    "requestTitle": "<string>",
    "stateCode": "<string>",
    "street": "<string>"
}

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/createMdfRequest', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "activityCost": 0,
    "activityDescription": "<string>",
    "activityEndDate": "<string>",
    "activityStartDate": "<string>",
    "activityType": "<string>",
    "amountRequested": 0,
    "city": "<string>",
    "countryCode": "<string>",
    "postalCode": "<string>",
    "requestTitle": "<string>",
    "stateCode": "<string>",
    "street": "<string>"
  }),
});
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 = """
            {
              "activityCost": 0,
              "activityDescription": "<string>",
              "activityEndDate": "<string>",
              "activityStartDate": "<string>",
              "activityType": "<string>",
              "amountRequested": 0,
              "city": "<string>",
              "countryCode": "<string>",
              "postalCode": "<string>",
              "requestTitle": "<string>",
              "stateCode": "<string>",
              "street": "<string>"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partnerportal/createMdfRequest"))
            .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>",
  "mdfRequestId": "<string>"
}

Response

200 OK

application/json · object

Response object containing the result of filing a market development funds request.

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

mdfRequestIdstring | null

Identifier of the Salesforce MDF request that was created

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.