--- updatedAt: 2026-07-30T11:03:45.000Z agentTools: projectIndex: https://developer.orangelogic.com/llms.txt --- # Batch create or update public embed links Create or update up to 10,000 custom public embed links at once Links you create via API function in the same manner as custom links generated by users in the Orange Logic interface, such as in the Embed Links extension. To use this API, you must have the **GetBulkPermanentLinks** [Security Function](https://developer.orangelogic.com/reference/api-testing#orange-logic-security-functions-and-permissions).
Here is an example call using sample values for each of the query parameters described in the table below.
Example with Asynchronous execution ``` curl -X 'POST' \ 'https://mangovations.orangelogic.com/webapi/objectmanagement/share/batchupsertassetlinkswithcustomroute_41FD_v1' \ -H 'accept: text/plain' \ -H 'Content-Type: application/json-patch+json' \ -d '{ "records": [ { "title": "Instagram", "customRoute": "/public/Promenade-des-Anglais-Nice-TR1.auto", "assetID": "Q1N3620", "format": "TR1", "fileExtension": ".auto" "transformations": [ "c_x_0,c_y_129,c_w_656,c_h_364,c_whu_Pixel", "r_a_10" ] "expirationDate": "2026-07-25T12:55:05.943Z" }, { "customRoute": "/public/Historic-village-in-Provence-TR1.auto", "assetID": "Q1N3670", "format": "TR1", "expirationDate": "2026-07-25T12:55:05.943Z" } ], "executionOptions": { "executeAsynchronously": true } } ' ```
Example with Synchronous execution ``` curl -X 'POST' \ 'https://mangovations.orangelogic.com/webapi/objectmanagement/share/batchupsertassetlinkswithcustomroute_41FD_v1' \ -H 'accept: text/plain' \ -H 'Content-Type: application/json-patch+json' \ -d '{ "records": [ { "customRoute": "/public/Nice-coastline-TR1.auto", "assetID": "Q1N3622", "format": "TR1", "expirationDate": "2026-07-25T12:55:05.943Z" } ], "executionOptions": { "executeAsynchronously": false } }' ```
# OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "get-link", "version": "1.0" }, "servers": [ { "url": "https://{OrangeLogicURL}/webapi/objectmanagement/share", "variables": { "OrangeLogicURL": { "default": "OrangeLogicURL" } } } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://example.com/oauth2/token", "scopes": {} } } } } }, "security": [ { "sec0": [] } ], "paths": { "/batchupsertassetlinkswithcustomroute_41FD_v2": { "get": { "summary": "Batch create or update public embed links", "description": "Create or update up to 10,000 custom public embed links at once", "operationId": "batch-create-or-update-public-embed-links", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "description": "Include one object for each custom embed link URL you want to create. The maximum number you can create simultaneously is 10,000.", "items": { "properties": { "title": { "type": "string", "description": "The name of the link in the “Embed links” extension. If empty, the link will not appear in the extension." }, "customRoute": { "type": "string", "description": "To create a new link: Include the relative path of the URL you want to create.
To update a link’s path: Include the existing relative path. This path will be updated based on the parameters included in your request.
Notes: " }, "assetID": { "type": "string", "description": "The asset this link goes to. This can be the asset’s unique ID, unencrypted record ID, or encrypted record ID." }, "format": { "type": "string", "description": "The ID of the format you are creating the link to. For example, this could be a standard proxy such as TR1 or TR4. Alternatively, it could be a custom format your organization uses, such as “Instagram.”" }, "fileExtension": { "type": "string", "description": "The filename extension." }, "transformations": { "type": "array", "description": "The transformations applied to the format, using transformation URL syntax with a comma separator between each transformation.", "default": [], "items": { "type": "string" } }, "stickToCurrentVersion": { "type": "boolean", "description": "True: This link always goes to the current version of the asset.
False: This link always goes to the latest version of the asset." }, "trackingParameters": { "type": "object", "description": "Optional UTM tracking parameters that provide metrics about the link, but do not change its behavior.", "properties": { "name": { "type": "string", "description": "The UTM name, such as utm_source or utm_campaign." }, "value": { "type": "string", "description": "The UTM value, such as Instagram." } } }, "expirationDate": { "type": "string", "description": "The date and time. If no date is specified, the link is permanent.", "format": "date" }, "": { "type": "string" } }, "type": "object" } }, "executionOptions": { "type": "object", "description": "The manner in which the links are created.", "properties": { "executeAsynchronously": { "type": "boolean", "description": "True: This job is queued and the response returns the jobRecordID. Use the jobRecordID with the Custom Route Job Status API to check the job status or obtain the custom routes.
False: This job is executed immediately and the custom URLs are included in the response.
When you’re updating many links simultaneously, we recommend asynchronous execution." } } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Asynchronous (200)": { "value": "{}{\n \"isRunning\": true,\n \"jobRecordID\": \"2Z9XPH3T3T3\",\n \"results\": null,\n \"errors\": null\n}\n" }, "Synchronous": { "value": "{\n \"isRunning\": false,\n \"jobRecordID\": null,\n \"results\": [\n {\n \"assetID\": \"2Z9XC5NGEFS\",\n \"format\": \"TR1\",\n \"expirationDate\": \"2026-07-25T12:55:05.943Z\",\n \"link\": \"https://mango-cdn.orangelogic.com/public/nice-coastline-tr1.auto\"\n }\n ],\n \"errors\": []\n}\n" } }, "schema": { "type": "object", "properties": { "isRunning": { "type": "boolean", "example": false, "default": true }, "jobRecordID": {}, "results": { "type": "array", "items": { "type": "object", "properties": { "assetID": { "type": "string", "example": "2Z9XC5NGEFS" }, "format": { "type": "string", "example": "TR1" }, "expirationDate": { "type": "string", "example": "2026-07-25T12:55:05.943Z" }, "link": { "type": "string", "example": "https://mango-cdn.orangelogic.com/public/nice-coastline-tr1.auto" } } } }, "errors": { "type": "array", "items": { "type": "object", "properties": {} } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": false, "proxy-enabled": true }, "x-readme-fauxas": true } ```