Skip to main content
PUT
Update a component operation

Authorizations

Authorization
string
header
required

Path Parameters

component_id
string
required
operation_name
string
required

Body

application/json

Body of a PUT /v1/components/{component_id}/operations/{operation_name} request.

description

Explanation of what the operation does. Buildtime expressions use CampaignBuildtimeContext.

display_name

Human-readable label for the operation, shown in authoring surfaces. Buildtime expressions use CampaignBuildtimeContext.

request_schema

Choose between static or dynamic request schema. Buildtime expressions use CampaignBuildtimeContext.

response_schema

Choose between static or dynamic response schema. Buildtime expressions use CampaignBuildtimeContext.

Response

Successful response

Stored component operation definition. Fields display_name, description, request_schema, and response_schema are unevaluated and appear in buildtime-evaluatable form.

description
required

Explanation of what the operation does. Buildtime expressions use CampaignBuildtimeContext.

display_name
required

Human-readable label for the operation, shown in authoring surfaces. Buildtime expressions use CampaignBuildtimeContext.

name
string
required

Unique name of the operation within its component. Lowercase letters, digits, underscores and dashes only.

request_schema
required

The request schema as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.

response_schema
required

The response schema as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use CampaignBuildtimeContext.