CRM · Contacts

Record or withdraw a contact's consent to marketing email.

Sequence emails are marketing: they are sent only to contacts who agreed to receive them. Granting consent requires your attestation and the basis (how and when the contact agreed); both are kept in the audit log. Withdrawing needs neither. A contact who unsubscribed (CONTACT_UNSUBSCRIBED) or turned marketing email off in their own account (CONTACT_DECLINED) can't be opted back in this way; only they can.

put/api/v1/contacts/{id}/marketing-consent

Request

  • Base URL: https://api-dev.fusehealth.com
  • URL: https://api-dev.fusehealth.com/api/v1/contacts/{id}/marketing-consent
  • Auth: API key in header x-api-key

Path parameters

idstring required

Request body

consentedboolean required
attestationboolean

Required (true) when consented is true.

consentSource'web_form' | 'paper_form' | 'verbal' | 'email' | 'imported_list' | 'other'

Required when consented is true.

consentObtainedAtstring date

When the contact agreed. Required when consented is true; not in the future.

Response

Success

successboolean
messagestring

Changes

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