Calls

Record consent for marketing calls

Records that one person agreed to receive marketing calls from this project, so POST /calls with purpose marketing may call them. Under Dutch telemarketing rules a sales or promotional call to a consumer needs prior consent; since 1 July 2026 that also applies to existing customers. source says where it came from (form, call, import, manual) and evidence is your reference to the proof (a form entry id, a call id, a file and row), so it can be shown later. Record only consent the person really gave. The number is stored only as a keyed hash plus its last two digits. If valid consent for this number already exists, it is returned unchanged with 200. Only the project owner, or an API key with calls:write, can record consent.

post/call-consents

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/call-consents
  • 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)

Request body

phone_numberstring required

The number of the person who gave consent, in E.164. Stored only as a keyed hash plus its last two digits.

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

Where the consent came from: form (a form the person filled in), call (they said yes on a call), import (from your own records), manual (recorded by hand).

evidencestring required

A reference to the proof, so it can be shown later: a form entry id, a call id, a file and row, or a short note. Not the proof itself and no other personal data.

consented_atstring date-time

When the person gave consent (ISO 8601). Default: now. Cannot be in the future.

Response

Valid consent for this number already existed; it is returned unchanged.

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.