Reconciliation
In order to ensure there are no data discrepancies between your platform and FT CRM, we need you to build an reconciliation endpoint in the operator API.
Endpoint Needed From Operator
POST /reconciliation
We are only expecting to get back user_ids that has the key = true
So if we are requesting blocked
we are expecting to get back only blocked
users (ids).
Supported key should be
blocked
, excluded
, active
, consent_email
, consent_sms
, consent_telephone
, consent_post_mail
, consent_site_notification
, consent_push_notification
Example Request for reconcilation of blocks
Request:
{
"field": "blocked"
}
Response:
{
"users":["12345","1221312"],
"timestamp": "2020-01-01T10:00:00Z"
}
Example Request for reconcilation of exclusions
Request:
{
"field": "excluded"
}
Response:
{
"users":["12345","1221312"],
"timestamp": "2020-01-01T10:00:00Z"
}
Example Request for reconcilation of consents
Request:
{
"field": "consent_email"
}
Response:
{
"users":["12345","1221312"],
"timestamp": "2020-01-01T10:00:00Z"
}
Request:
{
"field": "consent_sms"
}
Response:
{
"users":["12345","1221312"],
"timestamp": "2020-01-01T10:00:00Z"
}
Request:
{
"field": "consent_telephone"
}
Response:
{
"users":["12345","1221312"],
"timestamp": "2020-01-01T10:00:00Z"
}
Request:
{
"field": "consent_post_mail"
}
Response:
{
"users":["12345","1221312"],
"timestamp": "2020-01-01T10:00:00Z"
}
Request:
{
"field": "consent_site_notification"
}
Response:
{
"users":["12345","1221312"],
"timestamp": "2020-01-01T10:00:00Z"
}
Request:
{
"field": "consent_push_notification"
}
Response:
{
"users":["12345","1221312"],
"timestamp": "2020-01-01T10:00:00Z"
}
Error handling
Should an error occur while streaming the response, we expect you to still return status 200 OK
but also include an error
field in the response with further details.
Request:
{
"field": "blocked"
}
Response:
{
"error": "timeout"
}