Resources API

Resources are what a plan unlocks: a place a connector gates (a channel, group or supergroup on Telegram today; each connector's own kinds as it launches) or a manually-tracked perk such as a PDF, a token or a URL. The REST API reads every resource, creates manual perks, and asks the connector to link a place; it never attaches a place itself.

A place is linked only through its connector, which proves the installation administers it before the resource exists. The link-request endpoint starts that conversation; the REST and MCP surfaces accept no place identifier, so a token can never attach an arbitrary place.

Endpoints

List a project's resources

GET

curl "https://api.subscriby.net/v1/projects/$PROJECT_ID/resources?kind=telegram:channel" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Newest first, paged with page and per_page, sortable with sort_by (created_at, kind, title, active) and sort_direction. kind narrows to one kind, connector to every resource one connector gates.

Requires ability

project-resource:view-any

The token must hold this ability, or the call is refused with 403.

MCP tool

list_resources

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

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

project*string

The project, resolved by the route binder.

Formatuuid

Query Parameters

kind?|

One kind of resource, spelled as the objects spell it: manual, or a connector's connector:kind as the connector directory lists each connector's resource_kinds. Any other shape is refused rather than answered with an empty page.

Match^(manual|[a-z][a-z0-9_-]*:[a-z][a-z0-9_-]*)$

connector?|

Every resource one connector gates, by the connector's key as the connector directory lists it.

Match^[a-z][a-z0-9_-]*$

page?integer

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

Range1 <= value

Default1

per_page?integer

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

Range1 <= value <= 100

Default25

sort_by?string

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

Default"created_at"

sort_direction?string

asc or desc. Defaults to desc.

Default"desc"

Value in

"asc"
"desc"

limit?integer

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Range1 <= value <= 100

Responses

200OKapplication/json

The page, newest first.

data*array<>

The items on this page.

links*

Links to the first, last, previous and next pages.

meta*

The paging counters for this page.

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).

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when kind is neither manual nor connector:kind, or connector is not a connector key; a typo in an automation is noticed instead of read as "no resources".

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources"

{  "data": [    {      "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "kind": "telegram:channel",      "connector": "telegram",      "space": null,      "title": "Research Premium Lounge",      "description": "Daily research notes and the members-only Q&A.",      "active": true,      "created_at": "2026-05-18T10:05:00Z",      "updated_at": "2026-05-18T10:05:00Z"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 1,    "total": 0  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: ResourceResource[];  links: Links;  meta: Meta;}export interface ResourceResource {  id: string;  project_id: string;  kind: string;  connector: string | null;  space: Space | null;  title: string;  description: string | unknown[] | null;  active: boolean;  created_at: string | null;  updated_at: string | null;}export interface Space {  id: string;  external_id: string;  title: string | null;}export interface Links {  first: string | null;  last: string | null;  prev: string | null;  next: string | null;}export interface Meta {  current_page: number;  from: number | null;  last_page: number;  links: Link[];  path: string | null;  per_page: number;  to: number | null;  total: number;}export interface Link {  url: string | null;  label: string;  active: boolean;}

Create a manual perk

POST

curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/resources \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{    "title": "Onboarding PDF",    "description": "https://example.com/onboarding.pdf"  }'

Answers 201 with the new resource, kind: "manual", and emits project.resource.created. The payload names no kind: a manual perk is the only resource this endpoint creates, and a place a connector gates is asked for with the link-request endpoint. A resource is what a plan unlocks, and nothing is sold before a connector can deliver it, so a project running no connected connector is refused, a manual perk included: install a connector on the project and connect it first.

Requires ability

project-resource:create

The token must hold this ability, or the call is refused with 403.

Fires one event

project.resource.created

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

create_resource

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

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.

Formatuuid

Request body

JSONWhat the request carriesRequiredapplication/json

A new manual perk. The payload names no kind and no place: a place a connector gates is asked for with the link-request endpoint.

title*string

The perk's name on plan cards, 5 to 255 characters.

Length5 <= length <= 255

description?|

What the perk is, up to 1,000 characters. HTML is filtered to a safe subset before storage.

Lengthlength <= 1000

active?boolean

Whether plans grant it right away. Defaults to true.

Responses

201Createdapplication/json

The new resource.

data*

The response's payload.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

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).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when title is missing or outside 5 to 255 characters, or description exceeds 1,000 characters.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X POST "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12" \  -H "Content-Type: application/json" \  -d '{    "title": "string"  }'

{  "data": {    "id": "0d4a7e19-5c2b-4f83-9a61-2e8b7c3d5f10",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "manual",    "connector": null,    "space": null,    "title": "Onboarding PDF",    "description": "https://example.com/onboarding.pdf",    "active": true,    "created_at": "2026-09-12T10:05:00Z",    "updated_at": "2026-09-12T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

Request

export interface StoreResourceRequest {  title: string;  description?: string | null;  active?: boolean;}

Response

export interface Response {  data: ResourceResource;}export interface ResourceResource {  id: string;  project_id: string;  kind: string;  connector: string | null;  space: Space | null;  title: string;  description: string | unknown[] | null;  active: boolean;  created_at: string | null;  updated_at: string | null;}export interface Space {  id: string;  external_id: string;  title: string | null;}

Get a resource

GET

One resource with its place, when it has one.

Field	Type	Notes
`kind`	string	`manual` for a perk the creator hands over by hand, otherwise `connector:kind` as the connector directory lists each connector's `resource_kinds` (`telegram:channel`, `telegram:group`, `telegram:supergroup`).
`connector`	string or null	The connector key the place is on; `null` for a manual perk.
`space`	object or null	The place the resource is bound to: its `id`, the platform's own `external_id` and its `title` as the connector last read it. `null` for a manual perk and for a place-kind resource that was unlinked.
`title`	string	The resource's name on plan cards; for a linked place, the place's title at link time.
`description`	string or null	Up to 1,000 characters of well-formed HTML, shown as a perk beside the title.
`active`	boolean	Whether plans grant it right now. An inactive resource keeps its link and its plans, but new members do not receive it.

A manual perk reads { "kind": "manual", "connector": null, "space": null, … }.

Requires ability

project-resource:view

The token must hold this ability, or the call is refused with 403.

MCP tool

get_resource

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

resource*string

The resource, resolved within the project by the route binder.

Formatuuid

Responses

200OKapplication/json

The resource.

data*

The response's payload.

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).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": {    "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "telegram:channel",    "connector": "telegram",    "space": {      "id": "3c1f7a58-2b6e-4d90-8f41-6a2e9c5d7b10",      "external_id": "-1001234567890",      "title": "Research Premium Lounge"    },    "title": "Research Premium Lounge",    "description": "Daily research notes and the members-only Q&A.",    "active": true,    "created_at": "2026-05-18T10:05:00Z",    "updated_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: ResourceResource;}export interface ResourceResource {  id: string;  project_id: string;  kind: string;  connector: string | null;  space: Space | null;  title: string;  description: string | unknown[] | null;  active: boolean;  created_at: string | null;  updated_at: string | null;}export interface Space {  id: string;  external_id: string;  title: string | null;}

Update a resource

PATCH

curl -X PATCH https://api.subscriby.net/v1/projects/$PROJECT_ID/resources/$RESOURCE_ID \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{ "title": "Members lounge (VIP)" }'

Partial by design: only the fields present in the body change, so a title-only update leaves the description exactly as stored, filtered HTML included, and logs no description edit. kind and space are not writable here: a resource keeps its kind for life, and its place moves only through the connector.

Answers 200 with the resource. When at least one field actually changed, project.resource.updated fires once with a changes map of {field: {from, to}}; a body that restates the stored values writes nothing and emits nothing.

Requires ability

project-resource:update

The token must hold this ability, or the call is refused with 403.

Fires one event

project.resource.updated

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

update_resource

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

resource*string

The resource, resolved within the project by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

Formatuuid

Request body

JSONWhat the request carriesOptionalapplication/json

The changes to a resource. Every field is optional and an omitted one keeps its stored value. kind and space are not writable: a resource keeps its kind for life, and its place moves only through the connector.

title?string

The resource's name on plan cards, 5 to 255 characters.

Length5 <= length <= 255

description?|

What the resource is, up to 1,000 characters, the same HTML filter as create; null clears it.

Lengthlength <= 1000

active?boolean

Whether plans grant it; the activate and deactivate endpoints flip the same switch.

Responses

200OKapplication/json

The resource after the change.

data*

The response's payload.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

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).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when title is outside 5 to 255 characters or description exceeds 1,000 characters.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X PATCH "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "telegram:channel",    "connector": "telegram",    "space": null,    "title": "Research Premium Lounge",    "description": "Daily research notes and the members-only Q&A.",    "active": true,    "created_at": "2026-05-18T10:05:00Z",    "updated_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

Request

export interface UpdateResourceRequest {  title?: string;  description?: string | null;  active?: boolean;}

Response

export interface Response {  data: ResourceResource;}export interface ResourceResource {  id: string;  project_id: string;  kind: string;  connector: string | null;  space: Space | null;  title: string;  description: string | unknown[] | null;  active: boolean;  created_at: string | null;  updated_at: string | null;}export interface Space {  id: string;  external_id: string;  title: string | null;}

Delete a resource

DELETE

Deletes the row. Plans that linked it stop granting it. Returns 204 No Content and emits project.resource.deleted.

Requires ability

project-resource:delete

The token must hold this ability, or the call is refused with 403.

Fires one event

project.resource.deleted

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

delete_resource

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

resource*string

The resource, resolved within the project by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

Formatuuid

Responses

204No content

No content

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

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).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X DELETE "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12"

No body on this response.

Request a place link

POST

A place cannot be created from the API: only the connector can prove it administers the place. This endpoint asks the creator, through the connector, to pick the place; the connector messages them with a picker and the resource appears the moment they choose, announced by project.resource.linked. Nothing is created by the call itself.

curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/resources/link-requests \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{ "kind": "telegram:channel" }'

Answers 202 Accepted once the creator has been asked. The dashboard's Send Request button on the resource editor and the request_resource_link tool run the same action.

Requires ability

project-resource:create

The token must hold this ability, or the call is refused with 403.

MCP tool

request_resource_link

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

Formatuuid

Request body

JSONWhat the request carriesRequiredapplication/json

Which kind of place to ask the creator for. Only a connector's kind can be requested; a manual perk is created outright with the create endpoint.

kind*string

A connector's kind of place spelled connector:kind, as the connector directory lists each connector's resource_kinds. manual and a bare kind word are refused.

Match^[a-z][a-z0-9_-]*:[a-z][a-z0-9_-]*$

Responses

202Acceptedapplication/json

202 with project_id, kind and status: request_sent.

data*

The response's payload.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

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).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when kind is manual or a bare kind word, when no connected connector on the project gates the kind, or when the creator cannot be reached on the connector; error.context.kind names the kind.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X POST "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources/link-requests" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12" \  -H "Content-Type: application/json" \  -d '{    "kind": "string"  }'

{  "data": {    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "telegram:channel",    "status": "request_sent"  }}

Type definitions

The shapes above as types, ready to paste into your client.

Request

export interface RequestResourceLinkRequest {  kind: string;}

Response

export interface Response {  data: Data;}export interface Data {  project_id: string;  kind: string;  status: string;}

Unlink a resource's place

POST

Detaches the place from a resource, so space reads null and the row becomes a placeholder. The resource stays in the project's list and keeps its kind, but no longer grants access through the connector. Re-linking goes through the connector again. Answers 200 with the resource and emits project.resource.unlinked.

Requires ability

project-resource:update

The token must hold this ability, or the call is refused with 403.

Fires one event

project.resource.unlinked

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

unlink_resource

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

resource*string

The resource, resolved within the project by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

Formatuuid

Responses

200OKapplication/json

The resource after the change.

data*

The response's payload.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

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).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X POST "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/unlink" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12"

{  "data": {    "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "telegram:channel",    "connector": "telegram",    "space": null,    "title": "Research Premium Lounge",    "description": "Daily research notes and the members-only Q&A.",    "active": true,    "created_at": "2026-05-18T10:05:00Z",    "updated_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: ResourceResource;}export interface ResourceResource {  id: string;  project_id: string;  kind: string;  connector: string | null;  space: Space | null;  title: string;  description: string | unknown[] | null;  active: boolean;  created_at: string | null;  updated_at: string | null;}export interface Space {  id: string;  external_id: string;  title: string | null;}

Activate a resource

POST

The switch on the dashboard's resource row, on. A plan grants only its active resources, so the resource returns to what new members receive. Idempotent and answers 200 with the resource; only a flip emits project.resource.updated, with changes.active.

Requires ability

project-resource:update

The token must hold this ability, or the call is refused with 403.

Fires one event

project.resource.updated

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

activate_resource

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

resource*string

The resource, resolved within the project by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

Formatuuid

Responses

200OKapplication/json

The resource after the change.

data*

The response's payload.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

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).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X POST "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/activate" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12"

{  "data": {    "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "telegram:channel",    "connector": "telegram",    "space": null,    "title": "Research Premium Lounge",    "description": "Daily research notes and the members-only Q&A.",    "active": true,    "created_at": "2026-05-18T10:05:00Z",    "updated_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: ResourceResource;}export interface ResourceResource {  id: string;  project_id: string;  kind: string;  connector: string | null;  space: Space | null;  title: string;  description: string | unknown[] | null;  active: boolean;  created_at: string | null;  updated_at: string | null;}export interface Space {  id: string;  external_id: string;  title: string | null;}

Deactivate a resource

POST

curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/resources/$RESOURCE_ID/deactivate \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)"

The switch on the dashboard's resource row, off. An inactive resource stays in the project and keeps its place, but a plan grants only its active resources, so it drops out of what new members receive until it is switched back on. Idempotent and answers 200 with the resource; only a flip emits project.resource.updated, with changes.active.

Requires ability

project-resource:update

The token must hold this ability, or the call is refused with 403.

Fires one event

project.resource.updated

Delivered to every endpoint subscribed to it once the change is made.

MCP tool

deactivate_resource

Runs the same action from an agent, behind the same ability.

Idempotent

Idempotency-Key

Send the header on every call; the same key replays the original response for 24 hours.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

project*string

The project, resolved by the route binder.

Formatuuid

resource*string

The resource, resolved within the project by the route binder.

Formatuuid

Header Parameters

Idempotency-Key*string

Formatuuid

Responses

200OKapplication/json

The resource after the change.

data*

The response's payload.

400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

error*

The one envelope every failure uses.

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).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

error*

The one envelope every failure uses.

404Not foundRESOURCE_NOT_FOUNDapplication/json

error*

The one envelope every failure uses.

409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json

The key was already used in the last 24 hours with a different request body.

error*

The one envelope every failure uses.

425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json

The first request with this key is still running; retry in a few seconds and the original response is replayed.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X POST "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/deactivate" \  -H "Idempotency-Key: 0199a4ae-6c02-7b5c-9f51-c5f0da5e2f12"

{  "data": {    "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "telegram:channel",    "connector": "telegram",    "space": null,    "title": "Research Premium Lounge",    "description": "Daily research notes and the members-only Q&A.",    "active": true,    "created_at": "2026-05-18T10:05:00Z",    "updated_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: ResourceResource;}export interface ResourceResource {  id: string;  project_id: string;  kind: string;  connector: string | null;  space: Space | null;  title: string;  description: string | unknown[] | null;  active: boolean;  created_at: string | null;  updated_at: string | null;}export interface Space {  id: string;  external_id: string;  title: string | null;}

Connectors APIEach connector's resource_kinds, with the labels, grant mode and plan shapes of every kind.ResourcesDefine what your subscribers unlock — manual perks, and the places your connectors gate.Webhook Events APIA read-only polling endpoint that surfaces the most recent webhook deliveries for a given event type.project.* eventslinked fires when the connector finishes a link request, and updated also fires when a recovery swap moves the place (changes.space_id); the endpoints below announce their own changes.

Resources API

EndpointsCopy Anchor Link

List a project's resourcesCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Create a manual perkCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request bodyCopy Anchor Link

ResponsesCopy Anchor Link

Get a resourceCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Update a resourceCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request bodyCopy Anchor Link

ResponsesCopy Anchor Link

Delete a resourceCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Request a place linkCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request bodyCopy Anchor Link

ResponsesCopy Anchor Link

Unlink a resource's placeCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Activate a resourceCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Deactivate a resourceCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Related

On this page

Endpoints

List a project's resources

Authorization

Path Parameters

Query Parameters

Responses

Create a manual perk

Authorization

Path Parameters

Header Parameters

Request body

Responses

Get a resource

Authorization

Path Parameters

Responses

Update a resource

Authorization

Path Parameters

Header Parameters

Request body

Responses

Delete a resource

Authorization

Path Parameters

Header Parameters

Responses

Request a place link

Authorization

Path Parameters

Header Parameters

Request body

Responses

Unlink a resource's place

Authorization

Path Parameters

Header Parameters

Responses

Activate a resource

Authorization

Path Parameters

Header Parameters

Responses

Deactivate a resource

Authorization

Path Parameters

Header Parameters

Responses