Support Inbox

Update a project's support settings

curl -X PATCH https://api.subscriby.net/v1/projects/$PROJECT_ID/support/settings \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "relay_mode": "owner_dm",
    "auto_reply": "Thanks, a person will reply within a day."
  }'

Answers 200 with the complete settings after the change. Every field is optional and an omitted one keeps its stored value, so the request above changes the relay and the auto-reply and leaves enabled, agent_name and notify_email alone. support.settings.updated fires only when at least one value actually changed, with the full settings and a changes map; a PATCH that resends the current values changes nothing and raises nothing.

forum_group needs a group the bot can post into. forum_group mirrors each member conversation into its own topic of a group with topics enabled. Switching the mode here does not link a group: the creator adds the project bot to such a group as an administrator (with permission to manage topics), the bot records the group itself and confirms by direct message. Until that happens, new member messages reach only the dashboard inbox. The group's id is never exposed by this endpoint.

patch/v1/projects/{project}/support/settings

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/support/settings
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Request body

enabledboolean

Whether a member's unrecognised message to the bot opens a conversation.

relay_mode'owner_dm' | 'forum_group' | 'none'

owner_dm, forum_group or none. Switching to forum_group does not link a group: the creator adds the project bot to a group with topics enabled as an administrator, the bot records the group itself and confirms; until then new member messages reach only the dashboard inbox.

agent_namestring nullable

The name outbound replies are prefixed with, up to 60 characters; null or an empty string clears it. Whitespace is trimmed.

auto_replystring nullable

The acknowledgement sent on a member's first message in a thread, up to 1,000 characters, well under the platform limit because it is sent with an identity header; null clears it.

notify_emailboolean

Whether the creator is emailed about new support activity.

Response

The settings, updated.

Example response

{
  "data": {
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "enabled": true,
    "relay_mode": "owner_dm",
    "agent_name": "Team Subscriby",
    "auto_reply": "Thanks, a person will reply within a day.",
    "updated_at": "2026-09-06T10:05:00+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.