Body
The list of tags for this person in a comma separated list. Any tags that do not exist yet will be created. Ex: (“paid user, newsletter”)
Notes associated with this person. HTML string or string.
All custom fields for a person This is just an example of an additional field you may have for your audience. The data_name for each field, if available, can be listed here.
double_opt_in
string
default: "not_required"
Double opt in status. Sends a confirmation email to the person subscribing to your audience if set to “required” (Default) Double opt in not required for this person
Triggers double opt in email and awaits the person’s confirmation
Person has successfully opted in to receive emails
Trigger any matching automations when this person is added
Response
Notes associated with this person
All custom fields for a person An example of a custom field you may have for your audience. The data name for each field, if available, can be listed here.
The list of tags for this person
This is the datetime (UTC) at which the person was created.
This is the datetime (UTC) for the last activity of this person. Example activities that update this field are: creation, open email, click email, unsubscribed from email
The status of the person. The person has not confirmed their double opt in email
The person's email failed to deliver (permanent)
The person has unsubscribed
curl --location --request POST 'https://app.audienceful.com/api/people/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
--data-raw '{
"email": "[email protected] ",
"tags": "paid user, newsletter",
"extra_data": {"custom_field": "New value"}
}'
{
"uid" : "jQKdwqp3YRRtTrwqUJEp7d" ,
"email" : "[email protected] " ,
"notes" : "" ,
"extra_data" : {
"custom_field" : "Test data" ,
},
"tags" : [
{
"name" : "Test tag" ,
"color" : "#f5e0e9"
}
],
"created_at" : "2023-08-03T02:44:56.122079Z" ,
"last_activity" : "2023-08-03T02:44:56.122079Z" ,
"status" : "active" ,
}