Kanorio

API reference

Consents

Customer API: GET /consents, PATCH /consents

Base URL https://{site}/api/v1/customerErrorsPagination

Channels the customer can be reached on (email, SMS, LINE, WhatsApp) with the current marketing status. Bounced or complained channels are locked.

Response 200

  • consentsobject[]required
  • consents[].channel"EMAIL" | "SMS" | "LINE" | "WHATSAPP"required
  • consents[].status"NEVER_SUBSCRIBED" | "PENDING" | "SUBSCRIBED" | "UNSUBSCRIBED" | "BOUNCED" | "COMPLAINED"required
  • consents[].changeablebooleanrequired

    False when the channel bounced or was reported as spam.

  • consents[].updatedAtstring | nullrequired
curlTypeScript
curl -X GET "https://{site}/api/v1/customer/consents" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN"

Recorded as a first-party consent change (source LOGIN) with IP and user agent as evidence; a previously unsubscribed customer can re-subscribe here.

Request body

  • channel"EMAIL" | "SMS" | "LINE" | "WHATSAPP"required
  • subscribedbooleanrequired

Response 200

  • consentobjectrequired
  • consent.channel"EMAIL" | "SMS" | "LINE" | "WHATSAPP"required
  • consent.status"NEVER_SUBSCRIBED" | "PENDING" | "SUBSCRIBED" | "UNSUBSCRIBED" | "BOUNCED" | "COMPLAINED"required
  • consent.changeablebooleanrequired

    False when the channel bounced or was reported as spam.

  • consent.updatedAtstring | nullrequired

Errors

  • VALIDATION 400
  • CONSENT_LOCKED 409
curlTypeScript
curl -X PATCH "https://{site}/api/v1/customer/consents" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'