Distribution

Build a deep link

Builds a start link against the project's connected installation. The payload depends on which query parameter you pass (at most one; an access code wins over a plan, and a plan over a custom parameter):

Query parameterResulting payloadActed on by the bot?
access_codethe code verbatimYes: redeemed on open.
plan_idthe plan's bare UUIDYes: opens that plan's checkout flow.
customthe caller-supplied stringNo, see below.
(none)project_<uuid>No: falls through to the project home, which is the intent.

Only a bare UUID is acted on. The bot acts on a start payload only when it is a bare UUID: it is matched against the project's plans first, then tried as an access code. custom payloads and the default project_<uuid> do not match that shape, so the bot ignores them and opens its home screen. custom is therefore a passthrough for your own tracking: the platform delivers it and you can read it off the update in a webhook consumer, but Subscriby neither stores it nor attaches it to the member.

curl "https://api.subscriby.net/v1/projects/$PROJECT_ID/distribution/deep-link?plan_id=$PLAN_ID" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
get/v1/projects/{project}/distribution/deep-link

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/distribution/deep-link
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Query parameters

plan_idstring uuid nullable

A plan of this project; the link then opens that plan's checkout. Answers 404 for a plan outside the project. Ignored when access_code is also sent.

access_codestring nullable

An access code, carried verbatim and redeemed when the link is opened. Wins over plan_id and custom.

customstring nullable

Your own tracking string, 1 to 64 characters of letters, digits, underscore or hyphen. Delivered by the platform but not acted on or stored by Subscriby. Used only when neither access_code nor plan_id is sent.

Response

The bot URL, the start payload and the assembled deep link.

Example response

{
  "data": {
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "bot_url": "https://example.org/research_bot",
    "start_payload": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "deep_link": "https://example.org/research_bot?start=a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
  }
}

Changes

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