Update a customer

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

patch

Update a customer.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

customerIdstringRequired

The ID of the customer.

Body

application/json

firstNamestring · min: 1Optional

lastNamestring · min: 1Optional

aliasstringOptional

phoneNumberstring · min: 1Optional

emailstring · min: 1Optional

preferredLanguagestring · enumOptionalPossible values:

biostringOptional

dobstring · dateOptional

genderstringOptional

sexstring · enumOptionalPossible values:

pronounstringOptional

facebookProfileURLstringOptional

instagramProfileURLstringOptional

tagsstring[]Optional

Responses

200

Successful Response

application/json

This an object representing a customer.

idstringOptional

phoneNumberstringOptional

firstNamestringOptional

lastNamestringOptional

aliasstringOptional

dobstring · dateOptional

pronounstringOptional

genderstringOptional

sexstring · enumOptionalPossible values:

preferredLanguagestring · enumOptionalPossible values:

emailstringOptional

biostringOptional

facebookProfileURLstringOptional

instagramProfileURLstringOptional

channelstringOptional

workplaceIdstringOptional

tagsstring[]Optional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

422

Validation Error

application/json

patch

/v1/agents/{agentId}/customers/{customerId}

HTTPcURLJavaScriptPython

PATCH /v1/agents/{agentId}/customers/{customerId} HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "firstName": "text",
  "lastName": "text",
  "alias": "text",
  "phoneNumber": "text",
  "email": "text",
  "address": {
    "formatted": "text",
    "timezone": "text"
  },
  "preferredLanguage": "en",
  "bio": "text",
  "dob": "2026-04-02",
  "gender": "text",
  "sex": "male",
  "pronoun": "text",
  "facebookProfileURL": "text",
  "instagramProfileURL": "text",
  "tags": [
    "text"
  ]
}

{
  "id": "text",
  "phoneNumber": "text",
  "firstName": "text",
  "lastName": "text",
  "alias": "text",
  "dob": "2026-04-02",
  "pronoun": "text",
  "gender": "text",
  "sex": "male",
  "preferredLanguage": "en",
  "email": "text",
  "bio": "text",
  "address": {
    "formatted": "text",
    "timezone": "text"
  },
  "facebookProfileURL": "text",
  "instagramProfileURL": "text",
  "channel": "text",
  "workplaceId": "text",
  "tags": [
    "text"
  ],
  "createdAt": "2026-04-02T06:22:06.008Z",
  "updatedAt": "2026-04-02T06:22:06.008Z"
}