Values to create the Double opt-in (DOI) contact
Request body which must comply to the following JSON Schema:
{
"required" : [ "email", "includeListIds", "redirectionUrl", "templateId" ],
"type" : "object",
"properties" : {
"email" : {
"type" : "string",
"description" : "Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.",
"format" : "email",
"example" : "elly@example.com"
},
"attributes" : {
"type" : "object",
"additionalProperties" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "string"
}, {
"type" : "boolean"
}, {
"type" : "array",
"items" : {
"type" : "string"
}
} ]
},
"description" : "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']}**\n",
"example" : {
"FNAME" : "Elly",
"LNAME" : "Roger",
"COUNTRIES" : [ "India", "China" ]
}
},
"includeListIds" : {
"type" : "array",
"description" : "Lists under user account where contact should be added",
"items" : {
"type" : "integer",
"description" : "Id of the list",
"format" : "int64",
"example" : 36
}
},
"excludeListIds" : {
"type" : "array",
"description" : "Lists under user account where contact should not be added",
"items" : {
"type" : "integer",
"description" : "Id of the list",
"format" : "int64",
"example" : 36
}
},
"templateId" : {
"type" : "integer",
"description" : "Id of the Double opt-in (DOI) template",
"format" : "int64",
"example" : 2
},
"redirectionUrl" : {
"type" : "string",
"description" : "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 }}**.\n",
"format" : "url",
"example" : "http://requestb.in/173lyyx1"
}
}
}
