Report an objection
report_objectionRecords an objection to direct marketing for one record, by record id or email hash. Scope licensee suppresses it for your organisation at once; scope emailmovers suppresses it database-wide within one working day and tells every licensee holding it. Free; it needs suppressions:write, and repeating the same objection returns the same suppression. Call it whenever a contact objects, in any channel. Lawful basis is UK GDPR Article 6(1)(f) legitimate interests; email audiences include corporate subscribers only by default (PECR), so sole traders and ordinary partnerships are left out unless the toggle is changed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| scope | Yes | licensee suppresses the record for your organisation at once; emailmovers suppresses it database-wide within one working day. | |
| channel | Yes | ||
| record_id | No | Format: a contact id: contact_ followed by a 26 character ULID in upper case Crockford base32, such as contact_01JA9X2V7XN3M9R6T1Y5W8ZAK8. | |
| received_at | Yes | RFC 3339 date and time, with Z or an offset such as +01:00. | |
| email_sha256 | No | SHA-256 of the trimmed, lower cased address, when the record id is not known. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | Yes | ||
| status | Yes | suppressed now, or pending until the database-wide overlay applies. | |
| record_id | Yes | ||
| effective_by | Yes | ||
| suppressed_at | Yes | ||
| suppression_id | Yes | The list the record now sits on. |