Get a project's support settings
/v1/projects/{project}/support/settings in the Support Inbox API.
curl https://api.subscriby.net/v1/projects/$PROJECT_ID/support/settings \ -H "Authorization: Bearer $SUBSCRIBY_TOKEN"| Field | Type | Notes |
|---|---|---|
enabled | boolean | Whether a member's unrecognised message to the bot opens a conversation. Off stops new threads reaching the inbox; existing ones are kept. |
relay_mode | string | owner_dm: the platform bot messages the project owner with an inline Reply button. forum_group: each conversation is mirrored into its own topic of a group the bot administers. none: the dashboard inbox is the only surface. |
agent_name | string or null | The name outbound replies are prefixed with so they read as coming from a person. null falls back to the project's default. |
auto_reply | string or null | Sent to a member on their first message in a thread. null sends nothing. |
notify_email | boolean | Whether the creator is emailed about new support activity. |
The keys drop the support_ prefix the columns carry: on this endpoint everything is about support.
The relay chat id is never exposed. The chat the
owner_dmrelay posts to, and the groupforum_groupmirrors into, are identifiers the bot handshake writes, not settings. They do not appear here and cannot be set from here.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Path Parameters
The project, resolved by the route binder.
uuidResponses
200OKapplication/json
The settings.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on