Bloss Docs

Update a script

Developers
PATCH
/brands/{brandId}/scripts/{scriptId}

Change a script: send only the fields to change, or markdown to replace its title, hooks and body. The next match re-scores posts against it. Changing the tag moves the script's posts to the new tag. Pausing it (active: false) keeps the posts it has.

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
scriptId*string

A script id from GET /brands/{brandId}/scripts.

Length1 <= length

Query Parameters

dryRun?string

"true": run every check and return { dryRun: true, wouldChange } without changing anything.

Value in"true""false"

Request Body

application/json
  1. body
code?string

Letters, digits, - and _. Unique in the brand, ignoring case.

Length1 <= length <= 12
title?string
Length1 <= length <= 200
hooks?array<>
Itemsitems <= 20
body?string
Lengthlength <= 20000
tagName?string

Moves the script's posts to this tag.

Length1 <= length <= 60
active?boolean
markdown?string

Replaces the title, hooks and body with the script in this Markdown in the Bloss script format: a top-level heading with the code in brackets and the title ("# (S5) I paid $40 in late fees"), a "## Hook 1", "## Hook 2"… section per hook with "On screen: …" and "Said: …" lines, and a "## Script" section with what the video says, one line per sentence. Sections like "## Demo direction" are kept for people and not matched. Several scripts can go in one text, separated by a line of "---". The code stays unless code is sent.

Length1 <= length <= 100000

Response Body

Success.

application/json
  1. response
id*string
code*string

Short label, unique in the brand (S1, 3A).

title*string
hooks*array<>
body*string

What the video says after the hook, as Markdown.

active*boolean

Matched against new posts. A paused script keeps the posts it has.

tag*|

The tag matched sets get.

source*|

Where the script came from: a Notion page ("notion"), a Google Doc ("gdoc") or text ("text"). Null when it was written field by field.

posts*integer

Posts that follow it.

Range-9007199254740991 <= value <= 9007199254740991
waitingForPick*integer

Posts waiting for a person whose best guess is this script.

Range-9007199254740991 <= value <= 9007199254740991
updatedAt*string
warnings*array<string>
curl -X PATCH 'https://example.com/api/v1/brands/string/scripts/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "code": "string",  "title": "string",  "hooks": [    {      "text": "string",      "verbal": "string"    }  ],  "body": "string",  "active": true,  "tag": {    "id": "string",    "name": "string"  },  "source": {    "kind": "notion",    "url": "string",    "readAt": "string"  },  "posts": -9007199254740991,  "waitingForPick": -9007199254740991,  "updatedAt": "string",  "warnings": [    "string"  ]}

Was this page helpful?