Update

API Reference

Contacts

Update a contact

client.contacts.update(stringphoneNumber, ContactUpdateParamsbody, RequestOptionsoptions?): contactContactstatusstringContactUpdateResponse

put/api/v2/contacts/{phone_number}

Update an existing contact

Parameters

phoneNumberstring

bodyassignedToEmailstringcompanyNamestringfirstNamestringlastNamestringsendblueNumberstringtagsarrayContactUpdateParams

Hide ParametersShow Parameters

assignedToEmailstring

optional

companyNamestring

optional

firstNamestring

optional

lastNamestring

optional

sendblueNumberstring

optional

tagsarray

optional

Array<string>

Returns

ContactUpdateResponse

Hide ParametersShow Parameters

contactassignedToEmailstringcompanyNamestringcreated_atstringfirstNamestringlastNamestringphonestringsendblueNumberstringtagsarrayverifiedbooleanContact

optional

statusstring

optional

HTTPTypeScript

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const contact = await client.contacts.update('+1234567890');

console.log(contact.contact);

200 Example

{
  "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"
}