Metadata

post
Update Identifier Metadata

https://api.zaius.com/v3/identifiers
This endpoint allows you to update metadata for an identifier.
Request
Response
Request
Body Parameters
metadata
required
object
object containing the metadata fields to be updated; the metadata fields must already exist on the identifier field
identifier_field_name
required
string
the field name for the identifier to be updated (e.g. email)
identifier_value
required
string
any valid identifier of this type (e.g. test@zaius.com)
Response
200: OK
{
"title": "Accepted",
"status": 202,
"timestamp": "2019-07-30T23:55:00.519Z"
}
Example Payload
[
{
"identifier_value": "test@zaius.com",
"identifier_field_name": "email",
"metadata" : {
"mailbox_provider": "google",
"primary_mailbox": true
}
}
]

get
Get Identifier Metadata

https://api.zaius.com/v3/identifiers/{field_name}?id={id}
This endpoint allows you to get identifier metadata.
Request
Response
Request
Path Parameters
field_name
required
string
the field name for the identifier being requested (e.g. email)
Query Parameters
id
required
string
the identifier value being requested (e.g. test@zaius.com)
Response
200: OK
{
"identifier_value": "john@example.com",
"identifier_field_name": "email",
"zaius_id": "abcd", //response only
"metadata" : {
"mailbox_provider": "google",
"primary_mailbox": true
},
"metadata_update_ts": 1556582935
}
Example Request
curl -iX GET \
'https://api.zaius.com/v3/identifiers/email?id=test@zaius.com' \
-H 'x-api-key: example.apiKey'