Calls

Revoke consent for marketing calls

Revokes a consent: from now on a marketing call to this number returns consent_required. Nothing is deleted; revoked_at is set and the evidence stays. Revoking twice is harmless. Do this as soon as the person says they no longer want to be called. Only the project owner, or an API key with calls:write, can revoke consent.

delete/call-consents/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/call-consents/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: calls:write)

Path parameters

idstring uuid required

The id of the consent.

Response

The consent, now revoked.

idstring uuid required

The id of the consent.

phone_number_endingstring required

The last two digits of the number. The number itself is never stored, only a keyed hash.

source'form' | 'call' | 'import' | 'manual' required

Where the consent came from: form, call, import or manual.

evidencestring required

Your reference to the proof.

consented_atstring date-time required

When the person gave consent.

recorded_atstring date-time required

When it was recorded here.

revoked_atstring date-time nullable required

When it was revoked; null while it is valid.

status'active' | 'revoked' required

active: marketing calls to this number are allowed. revoked: no longer.

Changes

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