Resources

Create a manual perk

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.

post/v1/projects/{project}/resources

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/resources
  • 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

titlestring required

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

descriptionstring nullable

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

activeboolean

Whether plans grant it right away. Defaults to true.

Response

The new resource.

Example response

{
  "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"
  }
}

Changes

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