Skip to main content
POST
/
v1
/
client
Create a client
curl --request POST \
  --url https://connect.provisionapp.io/v1/client \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "Sam",
  "lastName": "Client",
  "marketingOptOut": true,
  "emails": [
    {
      "value": "jsmith@example.com",
      "label": "<string>",
      "isPrimary": true
    }
  ],
  "phoneNumbers": [
    {
      "value": "+15551234567",
      "ext": 123,
      "label": "Mobile",
      "isPrimary": true
    }
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "partnerName": "<string>",
  "marketingOptOut": true,
  "emails": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "jsmith@example.com",
      "label": "<string>",
      "isPrimary": true
    }
  ],
  "phoneNumbers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "ext": 123,
      "label": "<string>",
      "isPrimary": true
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z"
}

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[]

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>