Create Caption

Add a new studio caption

Info

Required scope: studio.write

Warning

This method requires authentication

Create a studio caption owned by the authenticated user.

curl -X POST \
     -H "Authorization: Bearer [access token]" \
     -H "Content-Type: application/json" \
     -d '{"text": "Welcome to the stream!", "secondaryText": "Follow for more content", "brandId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"}' \
     https://api.restream.io/v2/user/studio/captions

Request Body

FieldTypeDescription
textstringCaption text (required)
secondaryTextstringSecondary caption text (optional)
brandIdstringBrand ID to associate with the caption (required)
{
  "text": "Welcome to the stream!",
  "secondaryText": "Follow for more content",
  "brandId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Response

Success
Error (Unauthorized)
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "text": "Welcome to the stream!",
  "secondaryText": "Follow for more content",
  "brandId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}