Sign in

v1

latestOpenAPI 3.0.32026-07-267015229.9 KB
Deployments

Patch Deployment

Apply a JSON Patch array to the deployment document.

Send the ETag from GET as If-Match for optimistic concurrency.

patch/v2/deployments/{deployment_id}

Path parameters

deployment_idstring required

Headers

If-Matchstring

ETag from a prior GET response.

Request body

object[] required

Example request

[
  {
    "op": "replace",
    "path": "/name",
    "value": "Support widget"
  }
]

Response

Updated deployment

deployment_idstring
pal_idstring

PAL that powers the deployment.

channel'widget' | 'embed' | 'landing-page'
status'draft' | 'active' | 'inactive'
namestring
has_passwordboolean
customizationobject
replica_thumbnail_video_urlstring nullable

Removed. Use thumbnail_video_url and thumbnail_image_url instead.

thumbnail_video_urlstring nullable

URL for the face preview video thumbnail.

thumbnail_image_urlstring nullable

URL for the face preview image thumbnail.

limitsobject
allowed_originsstring[]
usage_totalinteger
usage_todayinteger
created_atstring date-time
updated_atstring date-time

Example response

{
  "deployment_id": "d1234567890abcdef",
  "pal_id": "pcb7a34da5fe"
}