Skip to main content
POST
Creates a client (and its default location) for the service provider.

Authorizations

X-API-Key
string
header
required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Body

Client details.

Request body for creating a client, along with its default location.

Name
string
required

Client display name. Required. Maximum 150 characters.

Minimum string length: 1
Example:

"Contoso Ltd"

Location
object
required

Location details supplied when creating a client's default location.

BillingName
string | null

Optional name used on invoices when it differs from the display name. Maximum 150 characters.

AlternateName
string | null

Optional alternate / trading name. Maximum 500 characters.

Domain
string | null

Optional primary web domain for the client (e.g. contoso.com). Maximum 256 characters.

Response

OK

StatusCode
enum<integer>
Available options:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object

A single client, as returned by GET /v1/clients/{clientId}, POST and PATCH: the list shape plus its custom properties, which the list deliberately leaves out. Timestamps are UTC.

DataContext
object | null
Example:

null

Notifications
object[]