Contacts

Create Contact via DOI (Double-Opt-In) Flow

post/contacts/doubleOptinConfirmation

Request

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

Request body

emailstring email required

Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.

attributesobject

Pass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger', 'COUNTRIES':['India','China']}

includeListIdsinteger[] required

Lists under user account where contact should be added

excludeListIdsinteger[]

Lists under user account where contact should not be added

templateIdinteger required

Id of the Double opt-in (DOI) template

redirectionUrlstring url required

URL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}.

Example request

{
  "email": "elly@example.com",
  "attributes": {
    "FNAME": "Elly",
    "LNAME": "Roger",
    "COUNTRIES": [
      "India",
      "China"
    ]
  },
  "includeListIds": [
    36
  ],
  "excludeListIds": [
    36
  ],
  "templateId": 2,
  "redirectionUrl": "http://requestb.in/173lyyx1"
}

Response

DOI Contact created

Changes

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