Skip to main content
POST
/
api
/
partner
/
createPartnerClient
Create partner client
curl --request POST \
  --url https://api2.rhombussystems.com/api/partner/createPartnerClient \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "clientContactEmail": "john.smith@acme.com",
  "clientContactName": "John Smith",
  "clientOrgName": "Acme Corporation",
  "suppressWelcomeEmail": false
}
'
{
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "error": true,
  "errorMsg": "<string>",
  "responseStatus": "BASIC_AUTH_FAILED",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:partner-api-token
required

Authentication scheme indicator ("partner-api-token").

Required string length: 17

Body

application/json

Request object for creating a new partner client account.

​
clientContactEmail
string | null

Email address of the client contact person

Example:

"john.smith@acme.com"

​
clientContactName
string | null

Name of the client contact person

Example:

"John Smith"

​
clientOrgName
string | null

Name of the client organization

Example:

"Acme Corporation"

​
suppressWelcomeEmail
boolean | null

Whether to suppress sending welcome email to the client

Example:

false

Response

200 - application/json

OK

Response object containing the result of creating a partner client account.

​
clientOrgUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
error
boolean | null
​
errorMsg
string | null
​
responseStatus
enum<string>

Status responses for partner web operations.

Available options:
BASIC_AUTH_FAILED,
PASSWORD_MISMATCH,
USER_EXISTS,
CLIENT_EXISTS,
USER_NOT_FOUND,
BAD_INPUT,
SUCCESS,
PASSWORD_TOO_SHORT
​
warningMsg
string | null