Sign in
Uploads

Claim an upload and open a pull request

Changed on

Authorizes the caller's organization against the vendor manifest at the current head, re-validates the draft, and opens a pull request through the bot. Requires a Stytch session JWT.

post/v1/uploads/{id}/claim

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring required

Draft id to claim.

Request body

$schemastring uri

A URL to the JSON Schema for this object.

vendorstring

Vendor slug to attribute the change to (dev only; ignored when the GitHub bot is configured).

Example request

{
  "$schema": "https://example.com/v1/schemas/ClaimBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

alreadyExistedboolean

True when an idempotent retry returned an existing pull request.

branchstring

Head branch the change was committed to.

claimedboolean required

Always true on success.

filesstring[] nullable required

Repository paths the presets were placed at.

messagestring

Human-readable note, e.g. when no pull request was opened.

prCreatedboolean required

Whether a pull request was opened (false in dev without the bot).

pullRequestUrlstring

URL of the opened pull request, when one was created.

vendorstring required

Vendor slug the change was attributed to.

Example response

{
  "$schema": "https://example.com/v1/schemas/ClaimOutputBody.json"
}

Changes