BitelioBitelio

Register explicit customer permission for mobile follow-up

Merchant server only: derive contactId from the authenticated app customer, verify device permission and retain their explicit consent. Scope SURVEY permits surveys; RETENTION also permits help, recommendations and offers. No existing survey permission is silently expanded. Requires retention:view and retention:edit; shares the project channel API rate limit. Optional timeZone is the IANA zone reported by the authenticated customer device, for example America/New_York; never infer it from IP or country. It adjusts configured contact hours for 90 days, then falls back to the store zone. It does not expand consent or create a schedule.

POST
/v1/retention/mobile-permissions

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

contactId*string
Length1 <= length <= 100
scope*string
Value in"SURVEY" | "RETENTION"
consent*boolean
timeZone?string

Optional device-declared IANA time zone, captured only after explicit permission and tenant/customer verification.

Lengthlength <= 100
[key: string]?never

Response Body

application/json

curl -X POST "https://bitelio-api.heltia.com/v1/retention/mobile-permissions" \  -H "Content-Type: application/json" \  -d '{    "contactId": "string",    "scope": "SURVEY",    "consent": true  }'
{
  "id": "string",
  "status": "ACTIVE",
  "scope": "SURVEY"
}
Empty
Empty
Empty
Empty
Empty