Update a contact

Update a contact's attributes and custom field values.

Update a contact

patch

Update a contact's attributes and custom field values.

Only the properties present in the request body are changed, so a partial body is enough to change a single attribute. Sending a property as null clears it.

The response carries the contact's core attributes. Read back its tags, custom field values, source and note with GET /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

profileUuidstringRequired

Profile uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000

contactUuidstring · uuidRequired

Contact uuid parameter

Example: 550e8400-e29b-41d4-a716-446655440000

Body

Fields to change on a contact. Omitted properties are left untouched.

emailstring · nullableOptionalExample: [e-mail]

namestring · nullableOptionalExample: John

surnamestring · nullableOptionalExample: Doe

phonestring · max: 20 · nullableOptional

Phone number in E.164 format (leading "+" then 7-15 digits)

Example: [phone]

subscription_statusstring · enum · nullableOptionalExample: subscribedPossible values:

notestring · max: 75 · nullableOptionalExample: VIP customer

Responses

200

Success response

application/json

uuidstringOptionalExample: 550e8400-e29b-41d4-a716-446655440000

namestring · nullableOptionalExample: John

surnamestring · nullableOptionalExample: Doe

emailstringOptionalExample: [e-mail]

phonestring · nullableOptionalExample: [phone]

subscription_statusstring · enumOptionalExample: subscribedPossible values:

subscribed_atstring · date-time · nullableOptionalExample: 2023-01-01T00:00:00Z

unsubscribed_atstring · date-time · nullableOptionalExample: 2023-06-15T00:00:00Z

401

Unauthenticated response

application/json

422

Validation error response

application/json

500

Error response

application/json

patch/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}

PATCH /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid} HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "email": "[e-mail]",
  "name": "John",
  "surname": "Doe",
  "phone": "[phone]",
  "subscription_status": "subscribed",
  "note": "VIP customer",
  "fields": [
    {
      "uuid": "text",
      "value": "text",
      "selected_option_uuids": [
        "text"
      ]
    }
  ]
}

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "name": "John",
  "surname": "Doe",
  "email": "[e-mail]",
  "phone": "[phone]",
  "subscription_status": "subscribed",
  "subscribed_at": "2023-01-01T00:00:00Z",
  "unsubscribed_at": "2023-06-15T00:00:00Z"
}