Skip to navigation
Contact ManagementContacts

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

View as Markdown
How to use attributes param?
attributes param in this endpoint is an object containing key-value pairs where values can be either a string, integer, array, or boolean. You can create key-value pairs with these four datatypes. When a value is an array, it should be an array of strings.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Request

Values to create the Double opt-in (DOI) contact

emailstringRequiredformat: "email"
Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.
includeListIdslist of longsRequired
Lists under user account where contact should be added
redirectionUrlstringRequiredformat: "url"

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

templateIdlongRequired

Id of the Double opt-in (DOI) template

attributesmap from strings to doubles or strings or booleans or lists of stringsOptional

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’]}

contactPixelTrackingConsentbooleanOptional

Consent of the DOI recipient for open (pixel) and click tracking in the double opt-in confirmation email, resolved by the sender at send time. Considered only if the per-contact pixel tracking consent feature is enabled for your account. Pass true if this recipient has consented to open and click tracking, in which case the open pixel and tracked links identify the recipient. Pass false to anonymise the open and click events (counted in aggregate statistics only). If it is not passed, the recipient is treated as unknown consent status and the email is still sent (the open and click are anonymised unless your account tracks unknown-consent contacts). A value other than true/false is rejected. Ignored when the feature is not enabled for your account.

excludeListIdslist of longsOptional
Lists under user account where contact should not be added

Response

DOI Contact created

Errors

400
Bad Request Error