consent

Check whether a contact has active consent

get/consent/check

Request

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

Query parameters

numberIdstring required

The id of your number to check consent against.

peerNumberstring required

The contact phone number, in E.164 format (e.g. +14155550123), to check for active consent.

Response

Success

hasConsentboolean required
type'implied_inbound' | 'explicit_outbound' nullable

Changes

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