Skip to main content
POST
Create a client

Authorizations

x-api-key
string
header
required

Send the API key in the x-api-key header.

Body

application/json
firstName
string
required
Minimum string length: 1
Example:

"Sam"

lastName
string
required
Minimum string length: 1
Example:

"Client"

marketingOptOut
boolean
emails
object[]
phoneNumbers
object[]
customProperties
object

Custom property values, keyed by property id. Ids and value types come from the properties defined for your partner, so this object cannot be described field by field here: an unknown id or a value that does not match the property type is rejected with 400. Only the ids you send are modified — omit a property to leave it untouched. To clear one, send null; a blank string and an empty array count as empty too, for every property type alike.

Example:

Response

Created client

id
string
required
Pattern: ^ovcid-.*$
name
string
required
firstName
string
required
lastName
string
required
createdAt
string<date-time>
required
partnerName
string
marketingOptOut
boolean
emails
object[]
phoneNumbers
object[]
updatedAt
string<date-time>