Skip to content
Streamplace LogoStreamplace LogoStreamplace Docs

Apply a branding bundle (see exportBundle). By default the bundle replaces the node's branding: keys it does not mention are removed. Every value is validated like updateBlob. Requires admin authorization.

POST
/xrpc/place.stream.branding.importBundle
curl --request POST \
  --url 'https://example.com/xrpc/place.stream.branding.importBundle?merge=false&dryRun=false' \
  --header 'Content-Type: application/zip' \
  --data example

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
broadcaster

DID of the broadcaster. Defaults to this node’s.

string format: did

DID of the broadcaster. Defaults to this node’s.

merge

Keep keys the bundle does not mention instead of removing them.

boolean

Keep keys the bundle does not mention instead of removing them.

dryRun

Report what would change without writing anything.

boolean

Report what would change without writing anything.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/zip

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
applied
required

False for a dry run.

boolean
changes
required
Array<object>
object
key
required
string
action
required
string
detail

The new text value, or the image’s type and size.

string
warnings
Array<string>

Example generated

{
  "applied": true,
  "changes": [
    {
      "key": "example",
      "action": "example",
      "detail": "example"
    }
  ],
  "warnings": [
    "example"
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
error
required
One of:
string
Allowed value: Unauthorized
message
required
string

Example 

{
  "error": "Unauthorized"
}