Update Caption

Update a user's studio caption

Info

Required scope: studio.write

Warning

This method requires authentication

Update the text or secondary text of a studio caption owned by the authenticated user.

curl -X PATCH \
     -H "Authorization: Bearer [access token]" \
     -H "Content-Type: application/json" \
     -d '{"text": "Updated caption text", "secondaryText": "Updated secondary text"}' \
     https://api.restream.io/v2/user/studio/captions/{captionId}

Path Parameters

ParameterTypeDescription
captionIdstring (UUID)The ID of the caption to update

Request Body

FieldTypeDescription
textstringCaption text (optional)
secondaryTextstringSecondary caption text (optional)
{
  "text": "Updated caption text",
  "secondaryText": "Updated secondary text"
}

Response

Success
Error (Not Found)
Error (Unauthorized)
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "text": "Updated caption text",
  "secondaryText": "Updated secondary text",
  "brandId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}