inbox

Call inbox.set_entity_reply_instructions

Set how to reply to people writing in about ONE specific thing — 'anyone asking about this ad should be told we're booked out', 'reply differently to people from this sequence', 'special wording for enquiries on this page'. Set how the AI inbox replies to someone writing in about ONE specific thing — this ad campaign, this email sequence, this page, this post. It is the most specific layer, so it governs where it disagrees with the account-wide or channel wording. Pass an empty string to clear it, or exclusive=true to make it the whole prompt apart from pinned hard rules. Not for the account-wide wording — that is inbox.set_reply_instructions.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with workspace_ambiguous and lists the choices — offer them, never pick one.

post/api/v1/tools/inbox.set_entity_reply_instructions

Request

  • Base URL: https://app.goosybear.ai
  • URL: https://app.goosybear.ai/api/v1/tools/inbox.set_entity_reply_instructions
  • Auth: HTTP bearer

Headers

x-request-idstring

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Request body

entity_kind'email_campaign' | 'email_sequence' | 'ad_campaign' | 'page' | 'post' required

What kind of thing these instructions belong to.

entity_idstring required

The id of the campaign, page or post.

instructionsstring required

How the inbox should reply to someone writing in about this one thing. Empty clears it.

exclusiveboolean

Optional. True makes these instructions the whole prompt for replies about this thing — the account-wide and channel wording are dropped, apart from pinned hard rules. Leave it out to keep the current setting.

workspacestring

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

OR

Changes

No recorded changes to this operation across all 4 revisions of this API.