Skip to main content
PATCH
Update an action configuration

Autorizaciones

Authorization
string
header
requerido

Server-side tenant-scoped credential created from Build > API Keys.

Parámetros de ruta

actionId
string
requerido

Cuerpo

application/json
name
string
Required string length: 1 - 64
Pattern: ^[a-zA-Z_][a-zA-Z0-9_]{0,63}$
description
string
Required string length: 1 - 2000
parameters
object
endpoint
object
auth
object
active
boolean
readOnly
boolean
allowInPlayground
boolean
propertyIds
string[]
mode
enum<string>

off: unavailable; playground: Playground only; active: live channels and Playground. Do not combine mode with legacy state fields.

Opciones disponibles:
off,
playground,
active
playgroundOnly
boolean

Optional explicit availability setting; prefer mode. Omission preserves legacy HTTP eligibility.

scopeMode
enum<string>

tenant applies throughout this workspace and requires empty propertyIds; businesses uses explicitly selected active business IDs. Omission preserves legacy scope semantics. Scope is not an execution permission.

Opciones disponibles:
tenant,
businesses

Respuesta

Successful action operation

action
object
requerido