Skip to main content
POST
Create partner client

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:partner-api-token
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.

Available options:
api-token,
api,
partner-api-token,
partner-api

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
RUUID

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
Last modified on August 22, 2026