Contacts

Create a contact

post/contacts

Request

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

Request body

emailstring email

Email address of the user. Mandatory if "SMS" field is not passed in "attributes" parameter. 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 create a contact.

attributesobject

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

emailBlacklistedboolean

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

smsBlacklistedboolean

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

listIdsinteger[]

Ids of the lists to add the contact to

updateEnabledboolean

Facilitate to update the existing contact in the same request (updateEnabled = true)

smtpBlacklistSenderstring[]

transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )

Example request

{
  "email": "elly@example.com",
  "ext_id": "externalId",
  "attributes": {
    "FNAME": "Elly",
    "LNAME": "Roger"
  },
  "listIds": [
    36
  ]
}

Response

Contact created

idinteger

ID of the contact when a new contact is created

Example response

{
  "id": 122
}

Changes

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