---
title: "Call inbox.set_entity_reply_instructions"
method: POST
path: "/api/v1/tools/inbox.set_entity_reply_instructions"
tags: ["inbox"]
---

# Call inbox.set_entity_reply_instructions

`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

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.

## Headers

- `x-request-id` string

## Request body

- object
  - `entity_kind` 'email_campaign' | 'email_sequence' | 'ad_campaign' | 'page' | 'post', required: What kind of thing these instructions belong to.
  - `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.

## Response `200`

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.

- union
  - object: The tool ran and answered.
    - `ok` true, 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.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/6d82fb124064?raw)