Dokumentation
Sign inGet started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
Changelog

Create a WhatsApp keyword rule

POST
/v1/whatsapp/keyword-rules
const rule = await bird.whatsapp.keywordRules.create({
  operation: "opt_out",
  country: "US", // the SENDER's country, from their own number
  reply: "You're off the list. ACME Courier won't message you again.",
});
// effective_keywords is Bird's set plus any of your own.
console.log(rule.id, rule.effective_keywords);
Antwort201
{
  "id": "wkr_01krdgeqcxet5s7t44vh8rt9mg",
  "scope": "workspace",
  "operation": "opt_out",
  "country": "US",
  "waba": "102290129340398",
  "keywords": [
    "no more texts",
    "remove me"
  ],
  "effective_keywords": [
    "stop",
    "unsubscribe",
    "optout",
    "no more texts",
    "remove me"
  ],
  "reply": "You're off the list. ACME Courier won't message you again.",
  "created_at": "2026-09-15T10:04:00Z",
  "updated_at": "2026-09-15T10:04:00Z"
}
Creates a keyword rule. Use it to replace the reply Bird sends for opt_out or opt_in, or to add keywords your customers actually type.
Your rule takes precedence over Bird's at the same grain and keeps Bird's keywords unless you add more, so replacing a reply takes two fields. A keyword Bird has bound to one operation cannot be reused for the other.
Anfrage-Nutzlast
operation
string
erforderlich
What Bird does when an inbound message matches the rule.
  • opt_out records that the sender no longer consents to receive any messages from your WhatsApp Business Account, including transactional ones. Typing the word is the person's own statement, so it covers everything, unlike WhatsApp's built-in marketing opt-out control, which stops marketing alone.
  • opt_in records that they consent again.
A rule's operation is fixed once created, and a keyword belongs to exactly one operation, so a keyword Bird ships for opt_out cannot be reused for opt_in.
Closed on the write side: an operation Bird does not answer is rejected here rather than stored as a rule that never fires. The read side is open, because Bird can gain an operation without a new API version.
Possible values: opt_in, opt_out
country
string
The country this rule applies in, as an ISO 3166-1 alpha-2 code. It matches the country of the person who messaged you, worked out from their phone number. Omit it to cover everyone, which is what Bird's own rules do.
waba
string
Limit the rule to one WhatsApp Business Account, identified by its WhatsApp-issued account ID or by the waa_ ID Bird gives it. Either form resolves to the same account, and the rule stores and returns the WhatsApp-issued one. Omit it to cover every account in your workspace. The account must be one of yours.
keywords
array of string
Extra keywords to match, on top of the ones Bird already ships for this operation. Omit to keep Bird's keywords and change only the reply, including keywords Bird adds later. You cannot remove one of Bird's keywords, and a keyword Bird has bound to the other operation cannot be reused here.
reply
string
The message to send back when a keyword matches. Omit it to send nothing.
Antwort-Payload
id
string
erforderlich
scope
string
erforderlich
Whether the rule is one Bird ships (system) or one your workspace created (workspace). Both kinds carry a wkr_ ID and can be read; only a workspace rule can be changed or deleted. A workspace rule takes precedence over Bird's at the same grain, so it is how you replace a reply without losing the keywords Bird ships.
Possible values: system, workspace
operation
string
erforderlich
What Bird does when an inbound message matches the rule.
  • opt_out records that the sender no longer consents to receive any messages from your WhatsApp Business Account, including transactional ones. Typing the word is the person's own statement, so it covers everything, unlike WhatsApp's built-in marketing opt-out control, which stops marketing alone.
  • opt_in records that they consent again.
A rule's operation is fixed once created, and a keyword belongs to exactly one operation, so a keyword Bird ships for opt_out cannot be reused for opt_in.
This is an open enum. Accept unrecognized values: SMS already answers help, info, confirm and custom, and WhatsApp gains an operation without a new API version. Sending one Bird does not answer yet is refused with E15082.
Possible values (may grow over time): opt_in, opt_out
country
nullable string
The country the rule applies in, as an ISO 3166-1 alpha-2 code. It is the country of the person who messaged you, worked out from their phone number, not the country of the account they messaged. Null means the rule applies worldwide, which is what Bird's own rules do. A rule for a country outranks a worldwide rule for the people it covers.
waba
nullable string
The WhatsApp Business Account the rule is limited to, identified by its WhatsApp-issued account ID, or null when it covers every account in your workspace. Bird's own rules are always null.
keywords
array of string
erforderlich
The keywords this rule adds. For one of Bird's own rules this is the full set Bird ships. For a rule you created it is only what you added on top: it never restates or removes Bird's keywords, so effective_keywords is what actually matches.
effective_keywords
array of string
erforderlich
Every keyword that matches this rule: Bird's keywords for the same operation and country, plus the ones you added. This is what an inbound message is compared against, and the whole message has to equal one of them. Keywords Bird adds later join it without you changing anything. For a rule of yours with no country, this list is not the whole set it matches: such a rule compares against Bird's keywords for the sender's country, which the list cannot show because it does not know who is writing, so it shows Bird's worldwide keywords instead. Which rule answers decides whether that matters. Yours with no country and no waba sits below Bird's own country rule, so a sender in a country Bird ships a rule for is answered by that rule and your reply is not used. Yours with a waba and no country sits above it, so those senders match that country's keywords and get your reply, which is more keywords than this list names. Set a country on your own rule to see and extend exactly the set those senders match. A system rule is unaffected: each matches only its own keywords, and the ladder checks Bird's country rules separately from its worldwide one.
reply
nullable string
The message sent back when one of the keywords matches, or null when no reply is sent. The reply goes out on the conversation the inbound message opened.
created_at
string
erforderlich
When the rule was created. On one of Bird's own rules this is when Bird last shipped a change to it.
updated_at
string
erforderlich
When the rule was last changed. On one of Bird's own rules this is when Bird last shipped a change to it.

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema. Die Ressourcen sind auf Englisch.

Das Konzept verstehenShould I use a Bird SDK or call the API directly?Dem Lernpfad folgenBuild your first integrationImplementierungsleitfadenSend your first email
Implementierungs-Briefing erhalten