Create a Client

This endpoint allows a Partner create a Client resource. When creating a Client, a contact and location must also be created. A parent or direct Partner account must also be referenced.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Client to be created.

string
required
length ≤ 255

The Client's name.

string
length ≤ 50

Some Partners will have an merchant ids on their own software offerings. This is an open field that allows those Partner associate a Client resource with their Merchant Identifier.

boolean

This property indicates if the Client account is active or disabled. It is not possible to delete Clients, however their account can be set to inactive.

directPartner
object
required

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

location
object
required

A Location object.

contact
object
required

A User object.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json