Partner Portal

Create partner deal registration

Register a new deal for the authenticated partner organization. The submitting partner and all attribution are derived server-side from the authenticated session.

POST/api/partnerportal/createPartnerDealRegistration

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 registering a new deal on behalf of the authenticated partner organization.

additionalInformationstring | nullbody

Additional information about the deal

citystring | nullbody

City of the end customer

comfortableWithRhombusEUDemostring | nullbody

Whether the end customer is comfortable with a Rhombus end user demo

companystring | nullbodyrequired

Name of the end customer company

countryCodestring | nullbody

ISO country code of the end customer

Example: "US"

dealRegProductIntereststring[] | nullbody

Rhombus products the end customer is interested in

emailstring | nullbodyrequired

Email address of the end customer contact. This is the end customer's email, not the submitting partner's email.

estimatedNumberOfCamerasnumber | nullbody

Estimated number of cameras for the deal

firstNamestring | nullbody

First name of the end customer contact

governmentOwnedOrOperatedAccountstring | nullbody

Whether the end customer account is government owned or operated

governmentTypestring | nullbody

Type of government entity, for public sector deals

hubspotNoOfEmployeesstring | nullbody

Number of employees at the end customer company

industrystring | nullbody

Industry of the end customer

lastNamestring | nullbodyrequired

Last name of the end customer contact

otherDidntAgreeToEndUserDemostring | nullbody

Reason the end customer did not agree to an end user demo

partOfRFPboolean | nullbody

Whether this deal is part of an RFP

phonestring | nullbody

Phone number of the end customer contact

populationstring | nullbody

Population served by the end customer, for public sector deals

postalCodestring | nullbody

Postal code of the end customer

stateCodestring | nullbody

ISO state or province code of the end customer

Example: "CA"

streetstring | nullbody

Street address of the end customer

studentCountstring | nullbody

Number of students at the end customer, for education deals

timeframestring | nullbody

Expected purchasing timeframe for the deal

titlestring | nullbody

Job title of the end customer contact

websitestring | nullbody

Website of the end customer company

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partnerportal/createPartnerDealRegistration' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "additionalInformation": "<string>",
    "city": "<string>",
    "comfortableWithRhombusEUDemo": "<string>",
    "company": "<string>",
    "countryCode": "US",
    "dealRegProductInterest": [
      "<string>"
    ],
    "email": "<string>",
    "estimatedNumberOfCameras": 0,
    "firstName": "<string>",
    "governmentOwnedOrOperatedAccount": "<string>",
    "governmentType": "<string>",
    "hubspotNoOfEmployees": "<string>",
    "industry": "<string>",
    "lastName": "<string>",
    "otherDidntAgreeToEndUserDemo": "<string>",
    "partOfRFP": true,
    "phone": "<string>",
    "population": "<string>",
    "postalCode": "<string>",
    "stateCode": "CA",
    "street": "<string>",
    "studentCount": "<string>",
    "timeframe": "<string>",
    "title": "<string>",
    "website": "<string>"
  }'

import requests

url = "https://api2.rhombussystems.com/api/partnerportal/createPartnerDealRegistration"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "additionalInformation": "<string>",
    "city": "<string>",
    "comfortableWithRhombusEUDemo": "<string>",
    "company": "<string>",
    "countryCode": "US",
    "dealRegProductInterest": [
        "<string>"
    ],
    "email": "<string>",
    "estimatedNumberOfCameras": 0,
    "firstName": "<string>",
    "governmentOwnedOrOperatedAccount": "<string>",
    "governmentType": "<string>",
    "hubspotNoOfEmployees": "<string>",
    "industry": "<string>",
    "lastName": "<string>",
    "otherDidntAgreeToEndUserDemo": "<string>",
    "partOfRFP": True,
    "phone": "<string>",
    "population": "<string>",
    "postalCode": "<string>",
    "stateCode": "CA",
    "street": "<string>",
    "studentCount": "<string>",
    "timeframe": "<string>",
    "title": "<string>",
    "website": "<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/createPartnerDealRegistration', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "additionalInformation": "<string>",
    "city": "<string>",
    "comfortableWithRhombusEUDemo": "<string>",
    "company": "<string>",
    "countryCode": "US",
    "dealRegProductInterest": [
      "<string>"
    ],
    "email": "<string>",
    "estimatedNumberOfCameras": 0,
    "firstName": "<string>",
    "governmentOwnedOrOperatedAccount": "<string>",
    "governmentType": "<string>",
    "hubspotNoOfEmployees": "<string>",
    "industry": "<string>",
    "lastName": "<string>",
    "otherDidntAgreeToEndUserDemo": "<string>",
    "partOfRFP": true,
    "phone": "<string>",
    "population": "<string>",
    "postalCode": "<string>",
    "stateCode": "CA",
    "street": "<string>",
    "studentCount": "<string>",
    "timeframe": "<string>",
    "title": "<string>",
    "website": "<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 = """
            {
              "additionalInformation": "<string>",
              "city": "<string>",
              "comfortableWithRhombusEUDemo": "<string>",
              "company": "<string>",
              "countryCode": "US",
              "dealRegProductInterest": [
                "<string>"
              ],
              "email": "<string>",
              "estimatedNumberOfCameras": 0,
              "firstName": "<string>",
              "governmentOwnedOrOperatedAccount": "<string>",
              "governmentType": "<string>",
              "hubspotNoOfEmployees": "<string>",
              "industry": "<string>",
              "lastName": "<string>",
              "otherDidntAgreeToEndUserDemo": "<string>",
              "partOfRFP": true,
              "phone": "<string>",
              "population": "<string>",
              "postalCode": "<string>",
              "stateCode": "CA",
              "street": "<string>",
              "studentCount": "<string>",
              "timeframe": "<string>",
              "title": "<string>",
              "website": "<string>"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partnerportal/createPartnerDealRegistration"))
            .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>",
  "salesforceLeadId": "<string>"
}

Response

200 OK

application/json · object

Response object containing the result of registering a new deal.

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

salesforceLeadIdstring | null

Identifier of the Salesforce lead created for the registered deal

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.