Skip to main content
POST
Call inbox.set_reply_instructions

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

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.

Maximum string length: 128

Body

application/json
level
enum<string>

Where the instructions apply: account (every channel; the default), channel (send channel) or entity (send entity_kind and entity_id).

Available options:
account,
channel,
entity
instructions
string

How the inbox should reply at that level, in the account's own words. Empty clears it.

channel
enum<string>

Which channel these instructions apply to.

Available options:
email,
sms,
messenger,
ig_dm,
gbp_review,
fb_comment,
ig_comment,
whatsapp
entity_kind
enum<string>

What kind of thing these instructions belong to.

Available options:
ad_campaign,
page,
post
entity_id
string

The id of the campaign, page or post.

exclusive
boolean

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.

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.

The tool ran and answered.

ok
boolean
required
cleared
boolean
required
layer
string
entity
string

The plain-language kind of thing that was written.

exclusive
boolean

Whether this entity's instructions now replace the account-wide and channel wording entirely, apart from pinned hard rules.