Identifiers

post
Create Identifier

https://api.zaius.com/v3/schema/identifiers
Create a new identifier within Zaius that will be used for user resolution.
Request
Response
Request
Body Parameters
name
required
string
the field name of the identifier, ending with one of the known suffixes: id, hash, number, token, alias, address, key
display_name
required
string
the human-readable name, ending with title-case version of the name suffix: ID, Hash, Number, Token, Alias, Address, Key
merge_confidence
required
string
the level of confidence ("high" or "low") that this identifier can be used to merge customer profiles together and is NOT shared between individuals (eg, a shared device token)
messaging
optional
boolean
whether this identifier can be used to message customers within campaigns
Response
200: OK
{
"events": [
{
"name": "event_facebook_messenger_id",
"display_name": "Event Facebook Messenger ID",
"type": "identifier"
}
],
"customers": [
{
"name": "facebook_messenger_id",
"display_name": "Last Seen Facebook Messenger ID",
"type": "identifier"
}
]
}
400: Bad Request
{
"title": "Bad Request",
"status": 400,
"timestamp": "2018-08-07T13:44:17.659Z",
"detail": {
"invalids": [
{
"field": "customers.name",
"reason": "already used by another object"
},
{
"field": "customers.display_name",
"reason": "already used by another object"
}
]
}
}
Example Payload
{
"name": "facebook_messenger_id",
"display_name": "Facebook Messenger ID"
"merge_confidence": "high",
"messaging": true
}

‚Äč