Record that one person opted in, opted out or was suppressed for one purpose. Hive refuses to send where consent is not live, so this is what decides whether that person can be messaged again.

post/api/v1/tools/set_contact_consent

Request

  • Base URL: https://hivepublish.com
  • URL: https://hivepublish.com/api/v1/tools/set_contact_consent
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Required for every write.

Request body

contactIdstring required

The Hive contact identity.

purpose'conversation' | 'marketing' | 'email' | 'sms' | 'whatsapp' required

What the consent covers.

status'opted_in' | 'opted_out' | 'suppressed' required

What was recorded.

notestring

Why, in the words a teammate would use.

occurredAtstring

When it happened, as an ISO date. Defaults to now.

Response

Tool result

dataunknown required

Changes

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