Reconciliation

In order to ensure there are no data discrepancies between your platform and FT CRM, we need you to build a reconciliation endpoint in the operator API.

The reconciliation service is exclusively intended for fail safe purposes to ensure that consents, blocks, and excludes do not fall out of synchronization between FT CRM and the operator. Therefore, the reconciliation process will not generate block change events or consent change events to trigger any actions or lifecycles. It also won't remove users from lifecycles, even if they become blocked or excluded after entering the lifecycle.

⬆️ 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).

The Supported key should be:

blocked , excluded , consent_email , consent_sms, consent_telephone, consent_post_mail , consent_site_notification , consent_push_notification

Example Request for reconciliation of blocks:

Request

{
  "field": "blocked"
}

Response

{
   "users":["12345","1221312"],
   "timestamp": "2020-01-01T10:00:00Z"
}

Example Request for reconciliation of exclusions:

Request

{
  "field": "excluded"
}

Response

{
   "users":["12345","1221312"],
   "timestamp": "2020-01-01T10:00:00Z"
}

Example Request for reconciliation 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"
}

In the case of receiving an unknown field in a request from us, we expect you to return a 501 not implemented