Skip to content
SendBlue Docs
  • Auto
  • Light
  • Dark
Get Started

Update

API Reference
Contacts
Update a contact
contacts.update(strphone_number, ContactUpdateParams**kwargs) -> ContactUpdateResponse
put/api/v2/contacts/{phone_number}

Update an existing contact

ParametersExpand Collapse
phone_number: str
assigned_to_email: Optional[str]
company_name: Optional[str]
first_name: Optional[str]
last_name: Optional[str]
sendblue_number: Optional[str]
tags: Optional[SequenceNotStr[str]]
ReturnsExpand Collapse
class ContactUpdateResponse: …
contact: Optional[Contact]
assigned_to_email: Optional[str]

Email of assigned user

company_name: Optional[str]

Company name

created_at: Optional[datetime]

When the contact was created

formatdate-time
first_name: Optional[str]

First name

last_name: Optional[str]

Last name

phone: Optional[str]

Phone number in E.164 format

sendblue_number: Optional[str]

Associated Sendblue phone number

tags: Optional[List[str]]

Tags associated with the contact

verified: Optional[bool]

Whether the contact is verified

status: Optional[str]
Update a contact
  • http
  • typescript
  • python
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key="My API Key",
    api_secret="My API Secret",
)
contact = client.contacts.update(
    phone_number="+1234567890",
)
print(contact.contact)
{
  "contact": {
    "assignedToEmail": "[email protected]",
    "companyName": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+1234567890",
    "sendblueNumber": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  },
  "status": "OK"
}
Returns Examples
{
  "contact": {
    "assignedToEmail": "[email protected]",
    "companyName": "Example Corp",
    "created_at": "2024-01-15T10:30:00Z",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+1234567890",
    "sendblueNumber": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  },
  "status": "OK"
}