Compliance / CASL

Record CASL consent for up to 5,000 phone numbers

Each row is defaults with the row's own fields on top. Every row gets its own outcome: recorded, invalid, duplicate_in_file (the number appeared on an earlier row), opted_out (the number has opted out; never re-consented by an upload), revoked_by_review (HonkIO revoked the number's consent on review of an earlier upload; it cannot be recorded again unless HonkIO lifts the block) or already_recorded (an active consent at least as strong exists, so re-sending a file records nothing twice). The upload is kept as a consent batch (GET /v1/compliance/consent-batches). SMS only.

Requires compliance:w.

post/v1/compliance/consents/batch

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/compliance/consents/batch
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

file_namestring

The uploaded file's name, kept on the batch.

attestedboolean

The uploader confirms these people gave this consent or have this relationship. Recorded on the batch.

Response

Every row's outcome, in the order sent, and the counts. Partial success is normal: only a request that is wrong as a whole is refused.

batch_idstring required

cb_…

Changes

No recorded changes to this operation across all 1 revision of this API.