People
Create Person
This endpoint creates a new person in your audience
POST
/api/people/
X-Api-Key*
Body
emailrequired
string
The person’s email.
tags
string
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”)
extra_data
object
All custom fields for a person
trigger_automations
Default: "false"string
Trigger any matching automations when this person is added
Response
email
string
The person’s email.
extra_data
object
All custom fields for a person
tags
array
The list of tags for this person
created_at
string
This is the datetime (UTC) at which the person was created.
last_activity
datetime or null
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
unsubscribed
datetime or null
This is the datetime (UTC) at which the person unsubscribed from your audience.
curl --location --request POST 'https://app.audienceful.com/api/people/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
--data-raw '{
"email": "support@audienceful.com",
"tags": "paid user, newsletter",
"extra_data": {"custom_field": "New value"}
}'
{
"email": "support@audienceful.com",
"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",
"unsubscribed": null,
}
curl --location --request POST 'https://app.audienceful.com/api/people/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
--data-raw '{
"email": "support@audienceful.com",
"tags": "paid user, newsletter",
"extra_data": {"custom_field": "New value"}
}'
{
"email": "support@audienceful.com",
"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",
"unsubscribed": null,
}