Resources

Request a place link

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.

post/v1/projects/{project}/resources/link-requests

Request

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

kindstring required

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.

Response

202 with project_id, kind and status: request_sent.

Example response

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

Changes

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