Partner Portal

Update partner portal company info

Update the company profile of the authenticated partner organization. Only the fields present in the request are written; the organization name, reseller tier and the billing state and country display labels are not updatable and are rejected if supplied. A partnerType list containing the Managed Service Provider (MSP) value is rejected; that value is set by Rhombus in Salesforce.

POST/api/partnerportal/updateCompanyInfo

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 updating the company profile of the authenticated partner organization. Only the updatable fields appear here: there is deliberately no email and no organization field, because both are resolved from the authenticated principal, and accepting either from the body would let a caller write another partner's Account. Every field is optional, and a null value, a blank string or an empty list all leave the current value alone. Nothing can be cleared through this endpoint.

accessControlstring[] | nullbody

Access control platforms the organization works with, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.

alarmMonitoringApprovedboolean | nullbody

Whether the partner organization is approved for alarm monitoring

billingCitystring | nullbody

Billing city of the partner organization. Null or blank leaves the current value alone.

billingCountryCodestring | nullbody

Billing country as an ISO code (for example US). Only the ISO code is accepted, not the display name. Null or blank leaves the current value alone.

billingPostalCodestring | nullbody

Billing postal code of the partner organization. Null or blank leaves the current value alone.

billingStateCodestring | nullbody

Billing state as an ISO code (for example CA). Only the ISO code is accepted, not the display name, and it must be valid for the billing country. Null or blank leaves the current value alone.

billingStreetstring | nullbody

Billing street of the partner organization. Null or blank leaves the current value alone.

competitorsResellerOffersstring[] | nullbody

Competitor offerings the organization also resells, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.

confirmedAccessControlQualificationsboolean | nullbody

Whether the partner organization has confirmed its access control qualifications

offeredServicesstring[] | nullbody

Services the organization offers, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here.

partnerTypestring[] | nullbody

Partner types of the organization, as Salesforce multi-select picklist values. Null or an empty list leaves the current values alone; they cannot be cleared here. The Managed Service Provider (MSP) value is set by Rhombus, and a list containing it is rejected.

phonestring | nullbody

Primary phone number of the partner organization. Null or blank leaves the current value alone; it cannot be cleared here.

servicesGeographicCoveragestring | nullbody

Geographic coverage of the services the partner organization offers. Null or blank leaves the current value alone.

websitestring | nullbody

Website of the partner organization. Null or blank leaves the current value alone.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partnerportal/updateCompanyInfo' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "accessControl": [
      "<string>"
    ],
    "alarmMonitoringApproved": true,
    "billingCity": "<string>",
    "billingCountryCode": "<string>",
    "billingPostalCode": "<string>",
    "billingStateCode": "<string>",
    "billingStreet": "<string>",
    "competitorsResellerOffers": [
      "<string>"
    ],
    "confirmedAccessControlQualifications": true,
    "offeredServices": [
      "<string>"
    ],
    "partnerType": [
      "<string>"
    ],
    "phone": "<string>",
    "servicesGeographicCoverage": "<string>",
    "website": "<string>"
  }'

import requests

url = "https://api2.rhombussystems.com/api/partnerportal/updateCompanyInfo"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "accessControl": [
        "<string>"
    ],
    "alarmMonitoringApproved": True,
    "billingCity": "<string>",
    "billingCountryCode": "<string>",
    "billingPostalCode": "<string>",
    "billingStateCode": "<string>",
    "billingStreet": "<string>",
    "competitorsResellerOffers": [
        "<string>"
    ],
    "confirmedAccessControlQualifications": True,
    "offeredServices": [
        "<string>"
    ],
    "partnerType": [
        "<string>"
    ],
    "phone": "<string>",
    "servicesGeographicCoverage": "<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/updateCompanyInfo', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "accessControl": [
      "<string>"
    ],
    "alarmMonitoringApproved": true,
    "billingCity": "<string>",
    "billingCountryCode": "<string>",
    "billingPostalCode": "<string>",
    "billingStateCode": "<string>",
    "billingStreet": "<string>",
    "competitorsResellerOffers": [
      "<string>"
    ],
    "confirmedAccessControlQualifications": true,
    "offeredServices": [
      "<string>"
    ],
    "partnerType": [
      "<string>"
    ],
    "phone": "<string>",
    "servicesGeographicCoverage": "<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 = """
            {
              "accessControl": [
                "<string>"
              ],
              "alarmMonitoringApproved": true,
              "billingCity": "<string>",
              "billingCountryCode": "<string>",
              "billingPostalCode": "<string>",
              "billingStateCode": "<string>",
              "billingStreet": "<string>",
              "competitorsResellerOffers": [
                "<string>"
              ],
              "confirmedAccessControlQualifications": true,
              "offeredServices": [
                "<string>"
              ],
              "partnerType": [
                "<string>"
              ],
              "phone": "<string>",
              "servicesGeographicCoverage": "<string>",
              "website": "<string>"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partnerportal/updateCompanyInfo"))
            .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>"
}

Response

200 OK

application/json · object

Response object for updating the company profile of the authenticated partner organization. Carries success or failure only; re-read getCompanyInfo for the saved values.

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

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.