Phone Consents

Record call consent

Records consent to call a number for a purpose (marketing or transactional). Required before an outbound call can be placed.

post/phone-consents

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/phone-consents
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Request body

e164string
purpose'marketing' | 'transactional'
consent_method'web_form' | 'checkout' | 'import' | 'verbal' | 'api' | 'other'
timezonestring nullable
customerstring nullable

Customer ID

proofobject

Response

Consent recorded

idstring required
objectstring required
e164string required
purpose'marketing' | 'transactional' required
consent_method'web_form' | 'checkout' | 'import' | 'verbal' | 'api' | 'other' required
timezonestring nullable required
consented_atstring date-time required
revoked_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required
customerstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.