Contacts

Update a contact

put/contacts/{identifier}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/{identifier}
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Path parameters

identifierstring required

Email (urlencoded) OR ID of the contact

Request body

attributesobject

Pass the set of attributes to be updated. These attributes must be present in your account. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored.To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, { "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger"}. The attribute's parameter should be passed in capital letter while updating a contact. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in "SMS" field should be passed with proper country code. For example {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}

ext_idstring

Pass your own Id to update ext_id of a contact.

emailBlacklistedboolean

Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)

smsBlacklistedboolean

Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)

listIdsinteger[]

Ids of the lists to add the contact to

unlinkListIdsinteger[]

Ids of the lists to remove the contact from

smtpBlacklistSenderstring[]

transactional email forbidden sender for contact. Use only for email Contact

Example request

{
  "attributes": {
    "EMAIL": "newemail@domain.com",
    "FNAME": "Ellie",
    "LNAME": "Roger"
  },
  "ext_id": "updateExternalId",
  "smsBlacklisted": true,
  "listIds": [
    65
  ],
  "unlinkListIds": [
    36
  ]
}

Response

Contact updated

Changes

No recorded changes to this operation across all 2 revisions of this API.