Praecise Platform
Menu

Rivier/ Reference/ contacts

Contacts consent record

post/crm/contacts/{id}/consent

Record a consent decision with its proof (the words, the source, the policy version).

Before you call

Credential
Authorization: Bearer $KEY
Scope
contacts:write
Graphql
Mutation.contactsConsentRecord
Sdk
contacts.consent.record
Cli
contacts consent record
Events
contacts.consent.recorded

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • channelstringrequired
    One of: email, sms, whatsapp, phone.
  • purposestring
    Default: marketing. Pattern: ^[a-z][a-z0-9_]{0,29}$.
  • statestringrequired
    One of: granted, withdrawn, denied, pending.
  • sourcestringrequired
    At most 120 characters.
  • policyVersionstring
    At most 40 characters.
  • ipstring
    At most 64 characters.
  • userAgentstring
    At most 300 characters.
  • proofobject
  • atstring (date-time)

Responses

  • 201application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown