BitelioBitelio

Claim prepared surveys for a mobile backend

Requires retention:view, retention:edit and retention:activate. Mobile API must be enabled. Claims up to20 current programme invitations after current programme, withdrawal, actor and subsequent-purchase checks. Each invitation is handed off once. Deliver before claimExpiresAt and report an actual result; do not send an expired claim. The merchant must verify its native notification consent and use its own APNs/FCM provider. Store capability and receipt tokens securely; never put an sk_ key in the mobile app. Limit120 requests/minute shared perproject. Only survey invitations are returned. Use /v1/retention/messages/claim to handle other retention messages.

POST
/v1/retention/survey-deliveries/claim

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Autenticación mediante clave de API. Las claves secretas (sk_*) son obligatorias en todos los endpoints excepto /v1/track. Las claves públicas (pk_*) solo funcionan con el endpoint /v1/track para el seguimiento de eventos desde el cliente. El proyecto se deriva automáticamente de la clave.

In: header

Request Body

application/json

after?string
Lengthlength <= 100
[key: string]?never

Response Body

application/json

curl -X POST "https://bitelio-api.heltia.com/v1/retention/survey-deliveries/claim" \  -H "Content-Type: application/json" \  -d '{}'
{
  "items": [
    {
      "deliveryId": "string",
      "receiptToken": "string",
      "surveyUrl": "string",
      "surveyToken": "string",
      "contactId": "string",
      "locale": "string",
      "title": "string",
      "body": "string",
      "expiresAt": "2019-08-24T14:15:22Z",
      "claimExpiresAt": "2019-08-24T14:15:22Z"
    }
  ]
}
Empty
Empty
Empty
Empty
Empty