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.
Authorization
ApiKeyAuth API Key authentication. Secret keys (sk_*) are required for all endpoints except /v1/track. Public keys (pk_*) only work with the /v1/track endpoint for client-side event tracking. The project is automatically derived from the key.
In: header
Request Body
application/json
length <= 100Response 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"
}
]
}