POST /contacts/batch
Update multiple contactsServers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
contacts[] |
Array | No |
List of contacts to be updated |
contacts[].id |
Integer | No |
id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) |
contacts[].attributes |
Object | No |
Pass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, { "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger"}. 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"} |
contacts[].email |
String | No |
Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) |
contacts[].ext_id |
String | No |
Pass your own Id to update ext_id of a contact. |
contacts[].unlinkListIds[] |
Array | No |
Ids of the lists to remove the contact from |
contacts[].listIds[] |
Array | No |
Ids of the lists to add the contact to |
contacts[].smsBlacklisted |
Boolean | No |
Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) |
contacts[].emailBlacklisted |
Boolean | No |
Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true) |
contacts[].sms |
String | No |
SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms) |
contacts[].smtpBlacklistSender[] |
Array | No |
transactional email forbidden sender for contact. Use only for email Contact |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.