POST /contacts
Creates new contacts on Brevo. Contacts can be created by passing either -
1. email address of the contact (email_id),
2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}
3. ext_id
Servers
- 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 |
|---|---|---|---|
attributes |
Object | No |
Pass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored. These attributes must be present in your Brevo account. For eg: {"FNAME":"Elly", "LNAME":"Roger", "COUNTRIES": ["India","China"]} |
email |
String | No |
Email address of the user. Mandatory if "ext_id" & "SMS" field is not passed. |
ext_id |
String | No |
Pass your own Id to create a contact. |
listIds[] |
Array | No |
Ids of the lists to add the contact to |
smsBlacklisted |
Boolean | No |
Set this field to blacklist the contact for SMS (smsBlacklisted = true) |
updateEnabled |
Boolean | No |
Facilitate to update the existing contact in the same request (updateEnabled = true) Default value: false |
emailBlacklisted |
Boolean | No |
Set this field to blacklist the contact for emails (emailBlacklisted = true) |
smtpBlacklistSender[] |
Array | No |
transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true ) |
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.