consent

Record consent for a contact

post/consent

Request

  • Base URL: https://api.saperly.com
  • URL: https://api.saperly.com/consent
  • Auth: none required

Request body

numberIdstring required

The id of your number the consent is scoped to.

peerNumberstring required

The contact phone number, in E.164 format (e.g. +14155550123), that the consent applies to.

consentType'implied_inbound' | 'explicit_outbound' required

How consent was obtained: implied_inbound (the contact messaged you first) or explicit_outbound (the contact explicitly agreed to be contacted).

sourcestring required

A free-text note recording where or how consent was captured, kept for your audit trail (e.g. "web signup form").

Response

Success

idstring required
numberIdstring required
peerNumberstring required
consentType'implied_inbound' | 'explicit_outbound' required
sourcestring required
grantedAtstring required
revokedAtstring nullable required

Changes

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