Skip to main content
POST
https://app.audienceful.com
/
api
/
people
/
fields
curl --location --request POST 'https://app.audienceful.com/api/people/fields/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
--data-raw '{
    "name": "Test Field",
    "data_name": "test_field",
    "type": "string",
    "required": false
}'

{
    "id": "4XJA8RZ6kJRwMJYDBETyZa",
    "name": "Test Field",
    "data_name": "test_field",
    "type": "string",
    "editable": true,
    "required": false
}

​
Body

​
name
string
required
A human readable field name
​
data_name
string
required
The name of the field to be used in future API requests
​
type
string
required
The data type of the field
  • string
  • boolean
  • tag
  • number
​
editable
boolean
default:"true"
Whether or not the field can be edited

​
Response

​
id
string
The id of the field
​
name
string
The human readable name of the field
​
data_name
string
The data name of the field is used in subsequent API requests for people
​
editable
boolean
Allows the field to be edited or not (default fields such as email or tags are not editable)
​
type
string | boolean | tag | number
The type of data stored in the field
curl --location --request POST 'https://app.audienceful.com/api/people/fields/' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <token>' \
--data-raw '{
    "name": "Test Field",
    "data_name": "test_field",
    "type": "string",
    "required": false
}'

{
    "id": "4XJA8RZ6kJRwMJYDBETyZa",
    "name": "Test Field",
    "data_name": "test_field",
    "type": "string",
    "editable": true,
    "required": false
}