> ## Documentation Index > Fetch the complete documentation index at: https://docs.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a component operation > Declares a new operation on the component identified by `component_id`. ## OpenAPI ````yaml /api-reference/management.json post /v1/components/{component_id}/operations openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Blocks - name: Campaigns - name: Components - name: Components Operations - name: Components Settings - name: Domains - name: Email - name: Erasure - name: Event Streams - name: File Validation Monitors - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v1/components/{component_id}/operations: post: tags: - Components Operations summary: Create a component operation description: Declares a new operation on the component identified by `component_id`. operationId: createComponentOperation parameters: - in: path name: component_id required: true schema: type: string requestBody: content: application/json: example: description: description display_name: display_name name: name schema: $ref: '#/components/schemas/ComponentOperationCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ComponentOperationResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_build_failed: $ref: '#/components/examples/campaign_build_failed' campaign_component_absolute_name_missing: $ref: >- #/components/examples/campaign_component_absolute_name_missing campaign_component_description_out_of_range: $ref: >- #/components/examples/campaign_component_description_out_of_range campaign_component_display_name_contains_illegal_character: $ref: >- #/components/examples/campaign_component_display_name_contains_illegal_character campaign_component_display_name_out_of_range: $ref: >- #/components/examples/campaign_component_display_name_out_of_range campaign_component_id_missing: $ref: '#/components/examples/campaign_component_id_missing' campaign_component_name_already_in_use: $ref: '#/components/examples/campaign_component_name_already_in_use' campaign_component_name_contains_illegal_character: $ref: >- #/components/examples/campaign_component_name_contains_illegal_character campaign_component_name_out_of_range: $ref: '#/components/examples/campaign_component_name_out_of_range' campaign_component_not_found: $ref: '#/components/examples/campaign_component_not_found' campaign_component_type_validation_failed: $ref: >- #/components/examples/campaign_component_type_validation_failed campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_stale_version: $ref: '#/components/examples/campaign_stale_version' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' circular_component_reference: $ref: '#/components/examples/circular_component_reference' client_key_name_already_in_use: $ref: '#/components/examples/client_key_name_already_in_use' component_facets_not_found: $ref: '#/components/examples/component_facets_not_found' component_ids_and_references_both_provided: $ref: >- #/components/examples/component_ids_and_references_both_provided component_not_found: $ref: '#/components/examples/component_not_found' component_operation_name_already_in_use: $ref: >- #/components/examples/component_operation_name_already_in_use component_operation_name_contains_illegal_character: $ref: >- #/components/examples/component_operation_name_contains_illegal_character component_operation_name_missing: $ref: '#/components/examples/component_operation_name_missing' component_operation_name_out_of_range: $ref: '#/components/examples/component_operation_name_out_of_range' component_operation_name_reserved: $ref: '#/components/examples/component_operation_name_reserved' component_operation_schema_invalid: $ref: '#/components/examples/component_operation_schema_invalid' component_operation_schema_too_large: $ref: '#/components/examples/component_operation_schema_too_large' component_owner_not_supported: $ref: '#/components/examples/component_owner_not_supported' component_state_not_supported: $ref: '#/components/examples/component_state_not_supported' component_type_not_found: $ref: '#/components/examples/component_type_not_found' controller_state_misconfiguration: $ref: '#/components/examples/controller_state_misconfiguration' date_invalid: $ref: '#/components/examples/date_invalid' excessive_component_reference: $ref: '#/components/examples/excessive_component_reference' expression_invalid_syntax: $ref: '#/components/examples/expression_invalid_syntax' external_element_is_referenced_by_active_configuration: $ref: >- #/components/examples/external_element_is_referenced_by_active_configuration external_elements_cannot_have_multiple_references: $ref: >- #/components/examples/external_elements_cannot_have_multiple_references invalid_campaign_id: $ref: '#/components/examples/invalid_campaign_id' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' invalid_campaign_version: $ref: '#/components/examples/invalid_campaign_version' invalid_component_installed_into_socket: $ref: >- #/components/examples/invalid_component_installed_into_socket invalid_component_reference: $ref: '#/components/examples/invalid_component_reference' invalid_component_reference_socket_name: $ref: >- #/components/examples/invalid_component_reference_socket_name invalid_external_component_reference: $ref: '#/components/examples/invalid_external_component_reference' invalid_json: $ref: '#/components/examples/invalid_json' invalid_null: $ref: '#/components/examples/invalid_null' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_setting_filter: $ref: '#/components/examples/invalid_setting_filter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' orphan_external_component_reference: $ref: '#/components/examples/orphan_external_component_reference' rebuild_campaigns_build_failed: $ref: '#/components/examples/rebuild_campaigns_build_failed' redundant_component_reference: $ref: '#/components/examples/redundant_component_reference' self_component_reference: $ref: '#/components/examples/self_component_reference' settings_build_failed: $ref: '#/components/examples/settings_build_failed' unknown_source_clients: $ref: '#/components/examples/unknown_source_clients' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: ComponentOperationCreateRequest: description: Body of a `POST /v1/components/{component_id}/operations` request. properties: description: $ref: '#/components/schemas/DescriptionInComponentOperationCreateRequest' display_name: $ref: '#/components/schemas/DisplayNameInComponentOperationCreateRequest' name: description: >- Unique name of the operation within its component. Lowercase letters, digits, underscores and dashes only. type: string request_schema: $ref: '#/components/schemas/RequestSchemaInComponentOperationCreateRequest' response_schema: $ref: '#/components/schemas/ResponseSchemaInComponentOperationCreateRequest' required: - name type: object ComponentOperationResponse: description: >- Stored component operation definition. Fields `display_name`, `description`, `request_schema`, and `response_schema` are unevaluated and appear in buildtime-evaluatable form. properties: description: $ref: '#/components/schemas/DescriptionInComponentOperationResponse' display_name: $ref: '#/components/schemas/DisplayNameInComponentOperationResponse' name: description: >- Unique name of the operation within its component. Lowercase letters, digits, underscores and dashes only. type: string request_schema: $ref: '#/components/schemas/RequestSchemaInComponentOperationResponse' response_schema: $ref: '#/components/schemas/ResponseSchemaInComponentOperationResponse' required: - description - display_name - name - request_schema - response_schema type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object DescriptionInComponentOperationCreateRequest: description: >- Explanation of what the operation does. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayNameInComponentOperationCreateRequest: description: >- Human-readable label for the operation, shown in authoring surfaces. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - description: Static display name nullable: true title: Static Value type: string - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RequestSchemaInComponentOperationCreateRequest: description: >- Choose between static or dynamic request schema. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - allOf: - $ref: '#/components/schemas/JsonNode' description: Static request schema title: Static Value - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{requestSchema}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('requestSchema');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ResponseSchemaInComponentOperationCreateRequest: description: >- Choose between static or dynamic response schema. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - allOf: - $ref: '#/components/schemas/JsonNode' description: Static response schema title: Static Value - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseSchema}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('responseSchema');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DescriptionInComponentOperationResponse: description: >- Explanation of what the operation does. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - description: Literal description title: Static Value type: string - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DisplayNameInComponentOperationResponse: description: >- Human-readable label for the operation, shown in authoring surfaces. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - description: Literal display name title: Static Value type: string - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{displayName}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('displayName');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string RequestSchemaInComponentOperationResponse: description: >- The request schema as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - allOf: - $ref: '#/components/schemas/JsonNode' description: Literal request schema title: Static Value - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{requestSchema}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('requestSchema');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ResponseSchemaInComponentOperationResponse: description: >- The response schema as configured: a literal value, or an expression (type:string) when defined dynamically. Buildtime expressions use [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts oneOf: - allOf: - $ref: '#/components/schemas/JsonNode' description: Literal response schema title: Static Value - description: >- Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: handlebars@buildtime:{{responseSchema}} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('responseSchema');} externalDocs: description: CampaignBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string JsonNode: description: >- JSON Schema document describing the operation's response payload. Must be a valid [JSON Schema draft 2020-12](https://json-schema.org/draft/2020-12/schema) document. type: object examples: binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_build_failed: summary: campaign_build_failed value: code: campaign_build_failed http_status_code: 400 message: Campaign build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_absolute_name_missing: summary: campaign_component_absolute_name_missing value: code: campaign_component_absolute_name_missing http_status_code: 400 message: Campaign component absolute name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_description_out_of_range: summary: campaign_component_description_out_of_range value: code: campaign_component_description_out_of_range http_status_code: 400 message: Campaign component description length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_contains_illegal_character: summary: campaign_component_display_name_contains_illegal_character value: code: campaign_component_display_name_contains_illegal_character http_status_code: 400 message: >- Campaign component display name can only contain alphanumeric, dash, underscore, whitespace, asterisk, hash, dollar characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_display_name_out_of_range: summary: campaign_component_display_name_out_of_range value: code: campaign_component_display_name_out_of_range http_status_code: 400 message: Campaign component display name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_id_missing: summary: campaign_component_id_missing value: code: campaign_component_id_missing http_status_code: 400 message: Campaign component id is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_already_in_use: summary: campaign_component_name_already_in_use value: code: campaign_component_name_already_in_use http_status_code: 400 message: Campaign component name is already used by another component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_contains_illegal_character: summary: campaign_component_name_contains_illegal_character value: code: campaign_component_name_contains_illegal_character http_status_code: 400 message: >- Campaign component name can only contain alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_name_out_of_range: summary: campaign_component_name_out_of_range value: code: campaign_component_name_out_of_range http_status_code: 400 message: Campaign component name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_not_found: summary: campaign_component_not_found value: code: campaign_component_not_found http_status_code: 400 message: Campaign Component not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_component_type_validation_failed: summary: campaign_component_type_validation_failed value: code: campaign_component_type_validation_failed http_status_code: 400 message: Campaign component type validation failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_concurrent_update: summary: campaign_concurrent_update value: code: campaign_concurrent_update http_status_code: 400 message: >- Could not perform the operation. Campaign is currently updated by other process/user parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_has_pending_changes: summary: campaign_has_pending_changes value: code: campaign_has_pending_changes http_status_code: 400 message: Could not perform the operation. Campaign has pending changes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_locked: summary: campaign_locked value: code: campaign_locked http_status_code: 400 message: Could not perform the operation. The campaign is locked parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_stale_version: summary: campaign_stale_version value: code: campaign_stale_version http_status_code: 400 message: You can only modify the latest version of the campaign parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_version_malformed: summary: campaign_version_malformed value: code: campaign_version_malformed http_status_code: 400 message: Campaign version is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 circular_component_reference: summary: circular_component_reference value: code: circular_component_reference http_status_code: 400 message: Circular campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 client_key_name_already_in_use: summary: client_key_name_already_in_use value: code: client_key_name_already_in_use http_status_code: 400 message: Client key name is already used by another client key parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_facets_not_found: summary: component_facets_not_found value: code: component_facets_not_found http_status_code: 400 message: Component facets not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_ids_and_references_both_provided: summary: component_ids_and_references_both_provided value: code: component_ids_and_references_both_provided http_status_code: 400 message: Only one of componentIds or componentReferences may be provided parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_not_found: summary: component_not_found value: code: component_not_found http_status_code: 400 message: Component not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_name_already_in_use: summary: component_operation_name_already_in_use value: code: component_operation_name_already_in_use http_status_code: 400 message: >- Component operation name is already used by another operation on this component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_name_contains_illegal_character: summary: component_operation_name_contains_illegal_character value: code: component_operation_name_contains_illegal_character http_status_code: 400 message: >- Component operation name can only contain lowercase alphanumeric, dash and underscore characters parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_name_missing: summary: component_operation_name_missing value: code: component_operation_name_missing http_status_code: 400 message: Component operation name is missing parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_name_out_of_range: summary: component_operation_name_out_of_range value: code: component_operation_name_out_of_range http_status_code: 400 message: Component operation name length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_name_reserved: summary: component_operation_name_reserved value: code: component_operation_name_reserved http_status_code: 400 message: Component operation name is a reserved keyword parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_schema_invalid: summary: component_operation_schema_invalid value: code: component_operation_schema_invalid http_status_code: 400 message: >- Component operation schema is not a valid JSON Schema draft 2020-12 document parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_operation_schema_too_large: summary: component_operation_schema_too_large value: code: component_operation_schema_too_large http_status_code: 400 message: Component operation schema serialized length is out of range parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_owner_not_supported: summary: component_owner_not_supported value: code: component_owner_not_supported http_status_code: 400 message: Component owner not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_state_not_supported: summary: component_state_not_supported value: code: component_state_not_supported http_status_code: 400 message: Component state not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 component_type_not_found: summary: component_type_not_found value: code: component_type_not_found http_status_code: 400 message: Component type was not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 controller_state_misconfiguration: summary: controller_state_misconfiguration value: code: controller_state_misconfiguration http_status_code: 400 message: A controller has not properly configured state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 date_invalid: summary: date_invalid value: code: date_invalid http_status_code: 400 message: Date is invalid or not ISO-8601 compliant parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 excessive_component_reference: summary: excessive_component_reference value: code: excessive_component_reference http_status_code: 400 message: Root campaign component may have at most one reference parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 expression_invalid_syntax: summary: expression_invalid_syntax value: code: expression_invalid_syntax http_status_code: 400 message: Campaign build failed due expression invalid syntax parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_element_is_referenced_by_active_configuration: summary: external_element_is_referenced_by_active_configuration value: code: external_element_is_referenced_by_active_configuration http_status_code: 400 message: External element is referenced by active configuration parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 external_elements_cannot_have_multiple_references: summary: external_elements_cannot_have_multiple_references value: code: external_elements_cannot_have_multiple_references http_status_code: 400 message: External elements cannot have multiple references parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_id: summary: invalid_campaign_id value: code: invalid_campaign_id http_status_code: 400 message: Invalid Campaign Id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_state: summary: invalid_campaign_state value: code: invalid_campaign_state http_status_code: 400 message: Invalid campaign state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_version: summary: invalid_campaign_version value: code: invalid_campaign_version http_status_code: 400 message: Invalid Campaign Version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_installed_into_socket: summary: invalid_component_installed_into_socket value: code: invalid_component_installed_into_socket http_status_code: 400 message: Invalid component installed into socket parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference: summary: invalid_component_reference value: code: invalid_component_reference http_status_code: 400 message: Unknown referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_component_reference_socket_name: summary: invalid_component_reference_socket_name value: code: invalid_component_reference_socket_name http_status_code: 400 message: Invalid component reference socket name parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_external_component_reference: summary: invalid_external_component_reference value: code: invalid_external_component_reference http_status_code: 400 message: Unknown external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_null: summary: invalid_null value: code: invalid_null http_status_code: 400 message: The attribute may be omitted but not nullified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_setting_filter: summary: invalid_setting_filter value: code: invalid_setting_filter http_status_code: 400 message: >- Invalid setting filter, expected format: name:value; backslash escapes the next character (e.g. \, \: \\) parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 lock_missing_lock_types: summary: lock_missing_lock_types value: code: lock_missing_lock_types http_status_code: 400 message: Unable to unlock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 orphan_external_component_reference: summary: orphan_external_component_reference value: code: orphan_external_component_reference http_status_code: 400 message: Orphan external referenced campaign component parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 rebuild_campaigns_build_failed: summary: rebuild_campaigns_build_failed value: code: rebuild_campaigns_build_failed http_status_code: 400 message: Rebuild campaigns build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 redundant_component_reference: summary: redundant_component_reference value: code: redundant_component_reference http_status_code: 400 message: Same reference defined multiple times parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 self_component_reference: summary: self_component_reference value: code: self_component_reference http_status_code: 400 message: Self campaign component reference is not allowed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 settings_build_failed: summary: settings_build_failed value: code: settings_build_failed http_status_code: 400 message: Component settings build failed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unknown_source_clients: summary: unknown_source_clients value: code: unknown_source_clients http_status_code: 400 message: Some source client ids are unknown parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unlock_missing_lock_types: summary: unlock_missing_lock_types value: code: unlock_missing_lock_types http_status_code: 400 message: Unable to lock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````