Partner Webservice

Create partner client

Create a client account

post/api/partner/createPartnerClient

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/partner/createPartnerClient
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

allowDuplicateNameboolean nullable

MSP initiative (D8): create even if this MSP already manages an org with the same name (case-insensitive). Default false.

clientContactEmailstring nullable

Email address of the client contact person

clientContactNamestring nullable

Name of the client contact person

clientOrgNamestring nullable

Name of the client organization

suppressWelcomeEmailboolean nullable

Whether to suppress sending welcome email to the client

Example request

{
  "clientContactEmail": "john.smith@acme.com",
  "clientContactName": "John Smith",
  "clientOrgName": "Acme Corporation"
}

Response

OK

clientOrgUuidstring RUUID nullable

base 64 (url-safe) uuid string

errorboolean nullable
errorCodestring nullable

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

errorMsgstring nullable
responseStatus'BASIC_AUTH_FAILED' | 'PASSWORD_MISMATCH' | 'USER_EXISTS' | 'CLIENT_EXISTS' | 'USER_NOT_FOUND' | 'BAD_INPUT' | 'SUCCESS' | 'PASSWORD_TOO_SHORT'

Status responses for partner web operations.

warningMsgstring nullable

Example response

{
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.