Update customer

Updates a contact in place. Only the fields you send are changed. Properties are merged key by key, so omitted properties keep their values.

PUT/v1/customers/{id}

Path parameters

idstringrequired

Request body

requiredapplication/json

phoneNumberstring

E.164 phone number. Returns `400` if another contact in the inbox already has it.

max length 20

firstNamestring

max length 100

lastNamestring

max length 100

emailstring<email>

optoutboolean

Set `true` to stop texting the contact. Only set `false` when the contact has asked to receive texts again.

emailOptoutboolean

Set `true` to stop emailing the contact.

blockedboolean

propertiesobject

Custom properties to set on the contact.

Responses

200Successful response

idstring

orgstring

gymstring

The inbox the contact belongs to.

phoneNumberstring

E.164 phone number, unique within the inbox.

firstNamestring

lastNamestring

emailstring

optoutboolean

The contact opted out of texts. Helios will not text them.

emailOptoutboolean

The contact unsubscribed from email.

blockedboolean

sourcestring

How the contact was first created, for example `sms`, `form`, or `api`.

propertiesobject

Custom and integration properties. Returned when reading a single contact.

createdAtstring<date-time>

updatedAtstring<date-time>

400Another contact in the inbox already has this phone number

403The contact belongs to a different inbox

Request

curl -X PUT "https://api.sendhelios.com/v1/customers/string" \
  -H "Content-Type: application/json" \
  -d '{
  "phoneNumber": "+15555550123",
  "firstName": "string",
  "lastName": "string",
  "email": "<email>",
  "optout": true,
  "emailOptout": true,
  "blocked": true,
  "properties": {}
}'

const response = await fetch("https://api.sendhelios.com/v1/customers/string", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "phoneNumber": "+15555550123",
  "firstName": "string",
  "lastName": "string",
  "email": "<email>",
  "optout": true,
  "emailOptout": true,
  "blocked": true,
  "properties": {}
})
});

import requests

response = requests.put(
    "https://api.sendhelios.com/v1/customers/string",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "phoneNumber": "+15555550123",
  "firstName": "string",
  "lastName": "string",
  "email": "<email>",
  "optout": True,
  "emailOptout": True,
  "blocked": True,
  "properties": {}
},
)

Response

{
  "id": "string",
  "org": "string",
  "gym": "string",
  "phoneNumber": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "optout": true,
  "emailOptout": true,
  "blocked": true,
  "source": "string",
  "properties": {},
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}