Bloss Docs

Match posts to scripts now

Developers
POST
/brands/{brandId}/scripts/match

Match now, the same as the button on the Scripts page: read the transcripts of posts from the last 30 days and of unpaid cycles, score them against the active scripts, and set, keep or flag each one. It runs in the background: this answers 202 at once; follow it with GET /brands/{brandId}/scripts/runs. A match already running answers 202 with alreadyRunning. Without an active script it answers 400. Takes no body.

Authorization

bearerAuth videos:write
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, onboarding:read, onboarding:signatures, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read, groups:write, videos:write, onboarding:write, sync:write, payouts:write.

Scope: videos:write

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length

Response Body

Success.

application/json
  1. response
run*
alreadyRunning*boolean
curl -X POST 'https://example.com/api/v1/brands/string/scripts/match'
{  "run": {    "id": "string",    "trigger": "button",    "status": "queued",    "queuedAt": "string",    "finishedAt": "string",    "counts": {      "property1": 0,      "property2": 0    }  },  "alreadyRunning": true}

Was this page helpful?