Sign inGet Started

Record a preference

POST
/v1/preferences
const result = await bird.preferences.create({
  channel: "sms",
  handle: "+15550001234",
  status: "revoked",
});
console.log(result.applied, result.preference?.id);
Response200
{
  "transition_id": "prt_01krdgeqcxet5s7t44vh8rt9mg",
  "preference": {
    "id": "prf_01krdgeqcxet5s7t44vh8rt9mg",
    "channel": "sms",
    "handle": "+15550001234",
    "sender_scope": "+15557654321",
    "topic_id": null,
    "status": "revoked",
    "coverage": "non_transactional",
    "origin": "api_key",
    "source": "signup-form-v2",
    "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
    "complaint_message_id": null,
    "brand_id": null,
    "created_at": "2026-05-20T09:14:52Z",
    "updated_at": "2026-05-25T16:42:01Z"
  }
}

Records one statement, a grant or an opt-out, for a handle on one channel. Writing is an upsert: the key is the channel, handle, optional sender scope, and email Brand, and a new statement replaces the key's current one.

Statements are ordered by when they were made, not when they arrive. A statement older than the key's current one is refused and returned with applied: false alongside the statement that survived; refusals are recorded on the key's history. Granting over a stored opt-out needs consented_at later than the opt-out. For an email Brand complaint, only this individual-recipient operation can record the newer consent that clears complaint protection. Bulk writes and imports cannot clear it. Bird accepts your assertion that the recipient has consented; optional source describes where consent came from, without verification. Other applicable opt-outs and workspace-wide delivery blocks still apply. Consent history can still be retained when a later ordinary opt-out or deletion remains in force. Such a grant returns applied: false with the surviving preference, or null after deletion.

A 201 means this key had no record and one was created; a 200 returns the key's surviving record, or preference: null when a later deletion remains in force. The result distinguishes an effective preference write, repeat, or refusal.

Request Payload

handle
string
required

Who the statement is about: an email address on the email channel, a phone number in E.164 format on SMS, WhatsApp, and Apple Messages for Business.

channel
string
required

The channel a preference statement applies to. A preference addresses one channel: the handle that identifies the person differs per channel, so opting out of one channel says nothing about the others. New channels can be added over time, so a value outside this list can be returned.

Possible values (may grow over time): email, sms, whatsapp, amb

status
string
required

What the statement says: granted records consent to receive messages, revoked records an opt-out. There is no third state: a person who never stated anything simply has no preference on record.

Possible values: granted, revoked

coverage
string

How much traffic the statement covers. Defaults to non_transactional, which keeps transactional messages such as receipts and verification codes flowing. Apple Messages for Business phone invitations have no transactional exemption, so either value covers them.

Possible values: all, non_transactional

sender_scope
string

Limit the statement to one sender instead of the whole channel. On SMS this is the originator; on WhatsApp it identifies the business account; on Apple Messages for Business it is the Apple business ID used for invitations. Not supported on email, where preferences belong to the selected Brand.

source
string

Free-form note on where the statement came from: a form name, an import batch, a campaign. For a grant, it can describe how you collected consent. Stored verbatim and returned on the preference; Bird does not verify this note. It does not grant permission to clear a complaint.

consented_at
string

When the person consented, on a granted statement. Required evidence when granting over a stored opt-out: the grant applies only if this is later than the opt-out it reverses. May not be in the future.

brand_id
nullable string

Select the business for an email preference. Omitted or null selects the original business. Unsupported on other channels. An additional Brand supports non_transactional coverage only. Existing opt-outs can be recorded for archived Brands; grants to archived Brands return 422. A Brand not found in this workspace returns 404.

Response Payload

applied
boolean
required

Whether the request took effect. False when causal ordering or protected complaint rules refuse the request; the surviving statement is returned in preference. A grant returns false when a newer opt-out or deletion survives, even if its consent history is retained.

transition_id
nullable string
required

Identifies this write on the key's record, for applied and refused requests alike. Null when the write was a repeat of the current statement and recorded nothing new.

preference
nullable object
required

The key's surviving statement. Null after an applied delete, when the key is back to having no record. It is also null after a refused grant when a later deletion remains in force.

Show child attributes
preference.id
string
required
preference.channel
string
required

The channel a preference statement applies to. A preference addresses one channel: the handle that identifies the person differs per channel, so opting out of one channel says nothing about the others. New channels can be added over time, so a value outside this list can be returned.

Possible values (may grow over time): email, sms, whatsapp, amb

preference.handle
string
required

Who the statement is about: an email address on the email channel, a phone number in E.164 format on SMS, WhatsApp, and Apple Messages for Business.

preference.sender_scope
nullable string
required

The sender the statement is limited to, or null when it covers the whole channel. On SMS this is the originator the person replied to; on WhatsApp it identifies the business account that messaged them; on Apple Messages for Business it is the Apple business ID used for invitations. Email preferences use brand_id instead, so sender_scope is always null there.

preference.topic_id
nullable string
required

The topic the statement is limited to, or null when it covers every topic. Part of the key that identifies a statement, alongside sender_scope.

preference.status
string
required

What the statement says: granted records consent to receive messages, revoked records an opt-out. There is no third state: a person who never stated anything simply has no preference on record.

Possible values: granted, revoked

preference.coverage
string
required

How much traffic the statement covers. non_transactional covers marketing and other non-essential messages while transactional messages such as receipts and verification codes keep flowing; all covers every message including transactional ones. Apple Messages for Business phone invitations have no transactional exemption, so either value covers them.

Possible values: all, non_transactional

preference.effective_at
string
required

When the statement was made, as reported by whoever made it. This is what orders one key's statements: a write dated before this moment is refused rather than applied.

preference.origin
string
required

How the statement was made. Statements the person made themselves (unsubscribe_link, unsubscribe_event, keyword, preference_page, complaint) carry more weight than ones asserted on their behalf (api_key, user, import): deletion cannot remove a person's own opt-out. A Brand complaint can be cleared only by a newer opt-in through the individual-recipient preference operation. New origins can be added over time, so a value outside this list can be returned.

Possible values (may grow over time): unsubscribe_link, unsubscribe_event, keyword, preference_page, api_key, user, import, complaint

preference.source
nullable string

Free-form note on where the statement came from, as supplied when it was recorded: a form name, an import batch, a campaign. Null when none was given.

preference.consented_at
nullable string

When the person consented, as evidenced by whoever asserted the grant. Null on statements that carry no consent evidence, including every opt-out.

preference.contact_id
nullable string

The contact whose handle matched when the statement was recorded. Null when no contact matched at that moment; it is not updated when contacts change later.

preference.complaint_message_id
nullable string

The email that caused the most recent recorded spam complaint for this preference. Null when no complaint is recorded. Retained after a newer individual opt-in clears complaint protection; check status and origin for the current preference.

preference.brand_id
nullable string

The business this email preference belongs to.

preference.created_at
string
required
preference.updated_at
string
required