Sign in
clients

Create a new client

post/v1/clients

Request body

firstNamestring required

Client's first name.

lastNamestring required

Client's last name.

emailstring required

Client's email address. Must be a valid email on a non-blacklisted domain.

companyNamestring required

Client's company name.

permission'1' | '2' required

Access level for the client. Accepted values: "1" = Full access, "2" = Limited access.

Example request

{
  "firstName": "Maya",
  "lastName": "Client",
  "email": "maya.client@example.org",
  "companyName": "Acme Growth",
  "permission": "1"
}

Response

Client created successfully

{"stackTrail":"paths:/v1/clients:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Client created successfully","payload":null}}

Example response

{
  "message": "Client created successfully",
  "payload": null
}

Changes

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