BitelioBitelio

Create a native mobile survey session

The merchant backend must authenticate the customer and bind their device before requesting a session. Requires retention:view and retention:edit, active mobile permission and an accepted MOBILE_API delivery. contactId must match that exact delivery. receiptToken stays on the server. The returned token expires after 15 minutes (or invitation expiry), is bound to deviceId and is revoked by permission updates. Never put a secret key in the app. 120 requests/project/minute. See /guides/native-surveys.

POST
/v1/retention/mobile-survey-sessions

Authorization

ApiKeyAuth

AuthorizationBearer <token>

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

deliveryId*string
Formatuuid
contactId*string
Lengthlength <= 100
receiptToken*string
Formatuuid
deviceId*string
Match^[A-Za-z0-9_-]{16,128}$
[key: string]?never

Response Body

application/json

curl -X POST "https://bitelio-api.heltia.com/v1/retention/mobile-survey-sessions" \  -H "Content-Type: application/json" \  -d '{    "deliveryId": "73dc828d-801d-4d29-b7e4-e046662a5901",    "contactId": "string",    "receiptToken": "f7b0d1df-daa1-490a-b9fc-05372d34c946",    "deviceId": "string"  }'
{
  "sessionToken": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "capabilities": {
    "nativeQuestions": true,
    "conditionalQuestions": true,
    "resume": true,
    "choice": true,
    "multipleChoice": true,
    "rating": true,
    "explicitSubmission": true
  }
}
Empty
Empty
Empty
Empty
Empty
Empty