> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://next.developer.frame.io/platform/v4-experimental/api-reference/session-watermark-templates/update/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://next.developer.frame.io/_mcp/server. # Update session watermark template PATCH https://api.frame.io/v4/accounts/{account_id}/session_watermark_templates/{session_watermark_template_id} Content-Type: application/json Update a session watermark template owned by an account.Rate Limits: 10 calls per 1.00 minute(s) per account\_user Reference: https://next.developer.frame.io/platform/v4-experimental/api-reference/session-watermark-templates/update ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `account_id` (string, required) - `session_watermark_template_id` (string, required) ### Headers - `api-version` (enum, required) - Allowed values: `experimental` ### Body (application/json) This endpoint expects an UpdateSessionWatermarkTemplateParams. - `data` (UpdateSessionWatermarkTemplateParamsData, required) ## Response ### 200 OK - `data` (SessionWatermarkTemplate, required) — A reusable configuration for a dynamic, per-viewer overlay painted onto streamed media. ## Errors ### 400 Bad Request Error Bad request - `errors` (list of BadRequestErrorsItems, required) ### 401 Unauthorized Error Unauthorized - `errors` (list of UnauthorizedErrorsItems, required) ### 403 Forbidden Error Forbidden - `errors` (list of ForbiddenErrorsItems, required) ### 404 Not Found Error Not found - `errors` (list of NotFoundErrorsItems, required) ### 409 Conflict Error Conflict - `errors` (list of ConflictErrorsItems, required) ### 422 Unprocessable Entity Error Unprocessable content - `errors` (list of UnprocessableContentErrorsItems, required) ### 429 Too Many Requests Error Too many requests - `errors` (list of TooManyRequestsErrorsItems, required) ## Types ### UpdateSessionWatermarkTemplateParamsData - `name` (string, optional) — Template name. - `watermark_blocks` (list of SessionWatermarkBlock, optional) — The positioned chunks of text to draw on the video. Replaces the existing blocks wholesale when provided. ### SessionWatermarkTemplate A reusable configuration for a dynamic, per-viewer overlay painted onto streamed media. - `created_at` (string, required) - `creator_id` (string, required, nullable) - `deleted_at` (string, required, nullable) - `id` (string, required) — Template ID. - `name` (string, required) — Template name. - `updated_at` (string, required) - `watermark_blocks` (list of SessionWatermarkBlock, required) ### BadRequestErrorsItems - `detail` (string, required) - `source` (BadRequestErrorsItemsSource, optional) - `title` (string, optional) ### UnauthorizedErrorsItems - `detail` (string, required) - `source` (UnauthorizedErrorsItemsSource, optional) - `title` (string, optional) ### ForbiddenErrorsItems - `detail` (string, required) - `source` (ForbiddenErrorsItemsSource, optional) - `title` (string, optional) ### NotFoundErrorsItems - `detail` (string, required) - `source` (NotFoundErrorsItemsSource, optional) - `title` (string, optional) ### ConflictErrorsItems - `detail` (string, required) - `source` (ConflictErrorsItemsSource, optional) - `title` (string, optional) ### UnprocessableContentErrorsItems - `detail` (string, required) - `source` (UnprocessableContentErrorsItemsSource, optional) - `title` (string, optional) ### TooManyRequestsErrorsItems - `detail` (string, required) - `source` (TooManyRequestsErrorsItemsSource, optional) - `title` (string, optional) ### SessionWatermarkBlock One positioned chunk of text drawn on the video, plus its formatting and content. - `data_points` (list of SessionWatermarkDataPoint, required) — The ordered lines of text. - `alpha` (double, optional) — Opacity from >0 to 1. - `font_size` (enum, optional) — Relative font size. - Allowed values: `small`, `medium`, `large`, `huge` - `name` (string, optional, nullable) — Human label for the block - `position` (enum, optional) — Named 9-grid slot. - Allowed values: `top_left`, `top_right`, `bottom_left`, `bottom_right`, `top_center`, `bottom_center`, `middle_left`, `middle_center`, `middle_right` - `position_reference_point` (enum, optional, nullable) — Anchor the free-form coordinates are measured from. - Allowed values: `top_left`, `top_right`, `bottom_left`, `bottom_right`, `top_center`, `bottom_center`, `middle_left`, `middle_center`, `middle_right` - `position_x` (double, optional, nullable) — Free-form X (0-1); overrides `position` when set. - `position_y` (double, optional, nullable) — Free-form Y (0-1); overrides `position` when set. - `rotation` (double, optional) — Rotation in degrees (-45.0 to 45.0). - `scroll_text` (enum, optional) — Scroll animation. - Allowed values: `none`, `rtl`, `ltr` - `text_alignment` (enum, optional) — Horizontal alignment. - Allowed values: `left`, `center`, `right` - `text_color` (string, optional) — Hex text color. - `text_shadow` (boolean, optional) — Draw a drop shadow behind the text. ### BadRequestErrorsItemsSource - `pointer` (string, optional) ### UnauthorizedErrorsItemsSource - `pointer` (string, optional) ### ForbiddenErrorsItemsSource - `pointer` (string, optional) ### NotFoundErrorsItemsSource - `pointer` (string, optional) ### ConflictErrorsItemsSource - `pointer` (string, optional) ### UnprocessableContentErrorsItemsSource - `pointer` (string, optional) ### TooManyRequestsErrorsItemsSource - `pointer` (string, optional) ### SessionWatermarkDataPoint One ordered line of text rendered within a block. `type` is resolved per viewer at play time; `value` holds fixed text and is only meaningful when `type` is `custom_text`. - `order` (double, required, nullable) — Render order within the block. - `type` (enum, required) — The dynamic value rendered for this line. - Allowed values: `email`, `username`, `ip_address`, `timestamp`, `custom_text`, `user_input` - `value` (string, optional, nullable) — Fixed text; only set when `type` is `custom_text`. ## Examples **Request** ```json { "data": { "name": "ABC Watermark (v2)", "watermark_blocks": [ { "data_points": [ { "order": 0, "type": "email", "value": null }, { "order": 1, "type": "ip_address", "value": null }, { "order": 2, "type": "timestamp", "value": null } ], "alpha": 0.5, "font_size": "medium", "name": "viewer-identity", "position": "bottom_center", "position_reference_point": null, "position_x": null, "position_y": null, "rotation": 0, "scroll_text": "rtl", "text_alignment": "center", "text_color": "#FFFFFF", "text_shadow": true } ] } } ``` **Response** ```json { "data": { "created_at": "2026-08-18T21:34:58.501275Z", "creator_id": "781d994f-390d-4f42-8d07-ef4ddd24215e", "deleted_at": null, "id": "6f1c9b2e-4c3a-4a1e-9b2e-0a1b2c3d4e5f", "name": "ABC Watermark", "updated_at": "2026-08-18T21:34:58.501275Z", "watermark_blocks": [ { "data_points": [ { "order": 0, "type": "email", "value": null }, { "order": 1, "type": "ip_address", "value": null }, { "order": 2, "type": "timestamp", "value": null } ], "alpha": 0.5, "font_size": "medium", "name": "viewer-identity", "position": "bottom_center", "position_reference_point": null, "position_x": null, "position_y": null, "rotation": 0, "scroll_text": "rtl", "text_alignment": "center", "text_color": "#FFFFFF", "text_shadow": true } ] } } ``` **SDK Code** ```python import requests url = "https://api.frame.io/v4/accounts/679b7960-1cd1-4689-b7f9-a33afabdba03/session_watermark_templates/d75decc5-0fad-4440-84b2-ff1502bf626f" payload = { "data": { "name": "ABC Watermark (v2)", "watermark_blocks": [ { "data_points": [ { "order": 0, "type": "email", "value": None }, { "order": 1, "type": "ip_address", "value": None }, { "order": 2, "type": "timestamp", "value": None } ], "alpha": 0.5, "font_size": "medium", "name": "viewer-identity", "position": "bottom_center", "position_reference_point": None, "position_x": None, "position_y": None, "rotation": 0, "scroll_text": "rtl", "text_alignment": "center", "text_color": "#FFFFFF", "text_shadow": True } ] } } headers = { "api-version": "experimental", "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.frame.io/v4/accounts/679b7960-1cd1-4689-b7f9-a33afabdba03/session_watermark_templates/d75decc5-0fad-4440-84b2-ff1502bf626f'; const options = { method: 'PATCH', headers: { 'api-version': 'experimental', Authorization: 'Bearer ', 'Content-Type': 'application/json' }, body: '{"data":{"name":"ABC Watermark (v2)","watermark_blocks":[{"data_points":[{"order":0,"type":"email","value":null},{"order":1,"type":"ip_address","value":null},{"order":2,"type":"timestamp","value":null}],"alpha":0.5,"font_size":"medium","name":"viewer-identity","position":"bottom_center","position_reference_point":null,"position_x":null,"position_y":null,"rotation":0,"scroll_text":"rtl","text_alignment":"center","text_color":"#FFFFFF","text_shadow":true}]}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.frame.io/v4/accounts/679b7960-1cd1-4689-b7f9-a33afabdba03/session_watermark_templates/d75decc5-0fad-4440-84b2-ff1502bf626f" payload := strings.NewReader("{\n \"data\": {\n \"name\": \"ABC Watermark (v2)\",\n \"watermark_blocks\": [\n {\n \"data_points\": [\n {\n \"order\": 0,\n \"type\": \"email\",\n \"value\": null\n },\n {\n \"order\": 1,\n \"type\": \"ip_address\",\n \"value\": null\n },\n {\n \"order\": 2,\n \"type\": \"timestamp\",\n \"value\": null\n }\n ],\n \"alpha\": 0.5,\n \"font_size\": \"medium\",\n \"name\": \"viewer-identity\",\n \"position\": \"bottom_center\",\n \"position_reference_point\": null,\n \"position_x\": null,\n \"position_y\": null,\n \"rotation\": 0,\n \"scroll_text\": \"rtl\",\n \"text_alignment\": \"center\",\n \"text_color\": \"#FFFFFF\",\n \"text_shadow\": true\n }\n ]\n }\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("api-version", "experimental") req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.frame.io/v4/accounts/679b7960-1cd1-4689-b7f9-a33afabdba03/session_watermark_templates/d75decc5-0fad-4440-84b2-ff1502bf626f") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["api-version"] = 'experimental' request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"data\": {\n \"name\": \"ABC Watermark (v2)\",\n \"watermark_blocks\": [\n {\n \"data_points\": [\n {\n \"order\": 0,\n \"type\": \"email\",\n \"value\": null\n },\n {\n \"order\": 1,\n \"type\": \"ip_address\",\n \"value\": null\n },\n {\n \"order\": 2,\n \"type\": \"timestamp\",\n \"value\": null\n }\n ],\n \"alpha\": 0.5,\n \"font_size\": \"medium\",\n \"name\": \"viewer-identity\",\n \"position\": \"bottom_center\",\n \"position_reference_point\": null,\n \"position_x\": null,\n \"position_y\": null,\n \"rotation\": 0,\n \"scroll_text\": \"rtl\",\n \"text_alignment\": \"center\",\n \"text_color\": \"#FFFFFF\",\n \"text_shadow\": true\n }\n ]\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.frame.io/v4/accounts/679b7960-1cd1-4689-b7f9-a33afabdba03/session_watermark_templates/d75decc5-0fad-4440-84b2-ff1502bf626f") .header("api-version", "experimental") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"data\": {\n \"name\": \"ABC Watermark (v2)\",\n \"watermark_blocks\": [\n {\n \"data_points\": [\n {\n \"order\": 0,\n \"type\": \"email\",\n \"value\": null\n },\n {\n \"order\": 1,\n \"type\": \"ip_address\",\n \"value\": null\n },\n {\n \"order\": 2,\n \"type\": \"timestamp\",\n \"value\": null\n }\n ],\n \"alpha\": 0.5,\n \"font_size\": \"medium\",\n \"name\": \"viewer-identity\",\n \"position\": \"bottom_center\",\n \"position_reference_point\": null,\n \"position_x\": null,\n \"position_y\": null,\n \"rotation\": 0,\n \"scroll_text\": \"rtl\",\n \"text_alignment\": \"center\",\n \"text_color\": \"#FFFFFF\",\n \"text_shadow\": true\n }\n ]\n }\n}") .asString(); ``` ```php request('PATCH', 'https://api.frame.io/v4/accounts/679b7960-1cd1-4689-b7f9-a33afabdba03/session_watermark_templates/d75decc5-0fad-4440-84b2-ff1502bf626f', [ 'body' => '{ "data": { "name": "ABC Watermark (v2)", "watermark_blocks": [ { "data_points": [ { "order": 0, "type": "email", "value": null }, { "order": 1, "type": "ip_address", "value": null }, { "order": 2, "type": "timestamp", "value": null } ], "alpha": 0.5, "font_size": "medium", "name": "viewer-identity", "position": "bottom_center", "position_reference_point": null, "position_x": null, "position_y": null, "rotation": 0, "scroll_text": "rtl", "text_alignment": "center", "text_color": "#FFFFFF", "text_shadow": true } ] } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', 'api-version' => 'experimental', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.frame.io/v4/accounts/679b7960-1cd1-4689-b7f9-a33afabdba03/session_watermark_templates/d75decc5-0fad-4440-84b2-ff1502bf626f"); var request = new RestRequest(Method.PATCH); request.AddHeader("api-version", "experimental"); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"data\": {\n \"name\": \"ABC Watermark (v2)\",\n \"watermark_blocks\": [\n {\n \"data_points\": [\n {\n \"order\": 0,\n \"type\": \"email\",\n \"value\": null\n },\n {\n \"order\": 1,\n \"type\": \"ip_address\",\n \"value\": null\n },\n {\n \"order\": 2,\n \"type\": \"timestamp\",\n \"value\": null\n }\n ],\n \"alpha\": 0.5,\n \"font_size\": \"medium\",\n \"name\": \"viewer-identity\",\n \"position\": \"bottom_center\",\n \"position_reference_point\": null,\n \"position_x\": null,\n \"position_y\": null,\n \"rotation\": 0,\n \"scroll_text\": \"rtl\",\n \"text_alignment\": \"center\",\n \"text_color\": \"#FFFFFF\",\n \"text_shadow\": true\n }\n ]\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "api-version": "experimental", "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["data": [ "name": "ABC Watermark (v2)", "watermark_blocks": [ [ "data_points": [ [ "order": 0, "type": "email", "value": ], [ "order": 1, "type": "ip_address", "value": ], [ "order": 2, "type": "timestamp", "value": ] ], "alpha": 0.5, "font_size": "medium", "name": "viewer-identity", "position": "bottom_center", "position_reference_point": , "position_x": , "position_y": , "rotation": 0, "scroll_text": "rtl", "text_alignment": "center", "text_color": "#FFFFFF", "text_shadow": true ] ] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/679b7960-1cd1-4689-b7f9-a33afabdba03/session_watermark_templates/d75decc5-0fad-4440-84b2-ff1502bf626f")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```