Skip to main content
POST
Call inbox.set_entity_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
entity_kind
enum<string>
required

What kind of thing these instructions belong to.

Available options:
ad_campaign,
page,
post
entity_id
string
required

The id of the campaign, page or post.

instructions
string
required

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

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.

workspace
string

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.

Minimum string length: 1

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
entity
string
required

The plain-language kind of thing that was written.

cleared
boolean
required
exclusive
boolean
required

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

workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.