Skip to content
Sendblue Docs
Get Started
API Reference
Contacts

Update a contact

PUT/api/v2/contacts/{phone_number}

Update an existing contact. You may set SMS opt-out with opt_out (boolean); it updates the same recipient record used for inbound keyword opt-outs.

Path ParametersExpand Collapse
phone_number: string
Body ParametersJSONExpand Collapse
assigned_to_email: optional string

Email of assigned user (preferred)

DeprecatedassignedToEmail: optional string

Deprecated, use assigned_to_email

company_name: optional string

Company name (preferred)

DeprecatedcompanyName: optional string

Deprecated, use company_name

custom_variables: optional map[string]

Custom key-value pairs. Merged with existing variables (not replaced).

first_name: optional string

Contact’s first name (preferred)

DeprecatedfirstName: optional string

Deprecated, use first_name

last_name: optional string

Contact’s last name (preferred)

DeprecatedlastName: optional string

Deprecated, use last_name

opt_out: optional boolean

Whether the contact has opted out of SMS (updates the same recipient record used for inbound keyword opt-outs)

DeprecatedoptOut: optional boolean

Deprecated, use opt_out

sendblue_number: optional string

Associated Sendblue phone number (preferred)

DeprecatedsendblueNumber: optional string

Deprecated, use sendblue_number

tags: optional array of string
ReturnsExpand Collapse
contact: optional Contact { assigned_to_email, company_name, created_at, 8 more }
assigned_to_email: optional string

Email of assigned user

company_name: optional string

Company name

created_at: optional string

When the contact was created

formatdate-time
custom_variables: optional map[string]

Custom key-value pairs stored on the contact. Keys are human-readable labels.

first_name: optional string

First name

last_name: optional string

Last name

opt_out: optional boolean

Whether the contact has opted out of SMS (from recipient opt-out state)

phone: optional string

Phone number in E.164 format

sendblue_number: optional string

Associated Sendblue phone number

tags: optional array of string

Tags associated with the contact

verified: optional boolean

Whether the contact is verified

status: optional string

Update a contact

curl https://api.sendblue.co/api/v2/contacts/$PHONE_NUMBER \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET" \
    -d '{
          "custom_variables": {
            "Plan": "Premium"
          }
        }'
{
  "contact": {
    "assigned_to_email": "[email protected]",
    "company_name": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "custom_variables": {
      "Lead Source": "Website",
      "Plan": "Enterprise"
    },
    "first_name": "John",
    "last_name": "Doe",
    "opt_out": false,
    "phone": "+1234567890",
    "sendblue_number": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  },
  "status": "OK"
}
Returns Examples
{
  "contact": {
    "assigned_to_email": "[email protected]",
    "company_name": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "custom_variables": {
      "Lead Source": "Website",
      "Plan": "Enterprise"
    },
    "first_name": "John",
    "last_name": "Doe",
    "opt_out": false,
    "phone": "+1234567890",
    "sendblue_number": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  },
  "status": "OK"
}