Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Adobe Launch Rule components API
version: '1.0'
description: 'Operations tagged Rule components across 2 of this provider''s published API definitions: adobe-launch-reactor-api-published-openapi.yml, adobe-launch-rule-components-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: //reactor.adobe.io
- url: https://reactor.adobe.io
description: Adobe Reactor API production gateway
tags:
- name: Rule components
description: 'Rule components are the individual items that make up a rule. Rule components have three basic types: events (what triggers a rule), conditions (what the rule checks to determine an action), and actions (what the rule executes depending on whether the condition is met). A rule component can **only** belong to exactly one rule.'
paths:
/rules/{RULE_ID}/rule_components:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rule components
summary: List a rule's components
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: listRuleComponents
parameters:
- name: RULE_ID
in: path
description: The ID of the rule whose rule components you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
- name: created_at
in: query
description: Filter by `created_at` timestamp.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
- name: dirty
in: query
description: Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library).
schema:
type: string
- name: enabled
in: query
description: Filter by `enabled`.
schema:
type: string
- name: name
in: query
description: Filter by `name`.
schema:
type: string
- name: negate
in: query
description: Filter by `negate` (whether the rule component represents a negation).
schema:
type: string
- name: origin_id
in: query
description: Filter by `origin_id`.
schema:
type: string
- name: published
in: query
description: Filter by `published` status.
schema:
type: string
- name: published_at
in: query
description: Filter by `published_at` timestamp.
schema:
type: string
- name: revision_number
in: query
description: Filter by `revision_number`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns a list of rule components attached to the rule.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsListResponse'
post:
tags:
- Rule components
summary: Create a new rule component
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: createRuleComponent
parameters:
- name: RULE_ID
in: path
description: The ID of the rule that you want to create a rule component for.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsCreatePayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created rule component.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsCreateResponse'
x-codegen-request-body-name: body
/rule_components/{RULE_COMPONENT_ID}:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rule components
summary: Retrieve a rule component
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: retrieveRuleComponent
parameters:
- name: RULE_COMPONENT_ID
in: path
description: The ID of the rule component you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the rule component.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsLookupResponse'
delete:
tags:
- Rule components
summary: Delete a rule component
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: deleteRuleComponent
parameters:
- name: RULE_COMPONENT_ID
in: path
description: The ID of the rule component you want to delete.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
responses:
'204':
x-summary: No content
description: A successful response returns HTTP status 204 (No Content).
content: {}
patch:
tags:
- Rule components
summary: Update a rule component
description: 'When updating a rule component, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.
>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: updateRuleComponent
parameters:
- name: RULE_COMPONENT_ID
in: path
description: The ID of the rule component you want to update.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsUpdatePayload'
required: true
responses:
'200':
x-summary: Success
description: A successful response returns the details of the new revision for the rule component.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsUpdateResponse'
x-codegen-request-body-name: body
/rule_components/{RULE_COMPONENT_ID}/extension:
servers:
- url: //reactor.adobe.io
get:
operationId: getRuleComponentExtension
tags:
- Rule components
summary: Look up the extension that provides a specific rule component.
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
parameters:
- name: RULE_COMPONENT_ID
in: path
description: The ID of the rule component whose extension you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: created_at
in: query
description: Filter by `created_at` timestamp.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
- name: text
in: query
description: Filter by `text`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the extension that provides the rule component.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsExtensionLookupResponse'
/rule_components/{RULE_COMPONENT_ID}/origin:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rule components
summary: Retrieve a rule component's origin
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: retrieveRuleComponentOrigin
parameters:
- name: RULE_COMPONENT_ID
in: path
description: The ID of the rule component whose origin you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: created_at
in: query
description: Filter by `created_at` timestamp.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
- name: text
in: query
description: Filter by `text`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the rule component's origin.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsOriginLookupResponse'
/rule_components/{RULE_COMPONENT_ID}/rules:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rule components
summary: List the rules that utilize a rule component
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: listRuleComponentsRelatedRules
parameters:
- name: RULE_COMPONENT_ID
in: path
description: The ID of the rule component whose related rules you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
- name: created_at
in: query
description: Filter by `created_at` timestamp.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
- name: text
in: query
description: Filter by `text`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns a list of related rules attached the rule component.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsRulesListResponse'
/rule_components/{RULE_COMPONENT_ID}/notes:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rule components
summary: List a rule component's notes
description: '>**NOTE**: For more information on using this operation, see the [notes endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/notes.html) on Experience League.'
operationId: listRuleComponentNotes
parameters:
- name: RULE_COMPONENT_ID
in: path
description: The ID of the rule component whose notes you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
- name: created_at
in: query
description: Filter by `created_at` timestamp.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
- name: text
in: query
description: Filter by `text`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns a list of notes attached the rule component.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsNotesListResponse'
post:
tags:
- Rule components
summary: Create a note for a rule component
description: '>**NOTE**: For more information on using this operation, see the [notes endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/notes.html) on Experience League.'
operationId: createRuleComponentNote
parameters:
- name: RULE_COMPONENT_ID
in: path
description: The ID of the rule component that you want to create a note for.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsNotesCreatePayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created note.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsNotesCreateResponse'
x-codegen-request-body-name: body
/properties/{propertyId}/rule_components:
servers:
- url: https://reactor.adobe.io
description: Adobe Reactor API production gateway
post:
operationId: createRuleComponent
summary: Create a Rule Component
description: Create a new rule component (event, condition, or action) under the specified property.
tags:
- Rule components
parameters:
- $ref: '#/components/parameters/propertyId'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/RuleComponentCreateRequest'
examples:
CreaterulecomponentRequestExample:
summary: Default createRuleComponent request
x-microcks-default: true
value:
data:
type: rule_components
attributes:
name: Example Title
delegate_descriptor_id: '500123'
order: 10
settings: example_value
timeout: 10
delay_next: true
negate: true
relationships:
rules:
data: {}
extension:
data: {}
responses:
'201':
description: Rule component created successfully.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/RuleComponentSingleResponse'
examples:
Createrulecomponent201Example:
summary: Default createRuleComponent 201 response
x-microcks-default: true
value:
data:
id: abc123
type: rule_components
relationships: {}
links:
self: https://www.example.com
'422':
$ref: '#/components/responses/UnprocessableEntity'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/rules/{ruleId}/rule_components:
servers:
- url: https://reactor.adobe.io
description: Adobe Reactor API production gateway
get:
operationId: listRuleComponentsForRule
summary: List Rule Components for a Rule
description: Retrieve all components belonging to a rule.
tags:
- Rule components
parameters:
- $ref: '#/components/parameters/ruleId'
- $ref: '#/components/parameters/filterCreatedAt'
- $ref: '#/components/parameters/filterName'
- $ref: '#/components/parameters/filterEnabled'
- $ref: '#/components/parameters/filterPublished'
- $ref: '#/components/parameters/filterUpdatedAt'
- $ref: '#/components/parameters/pageNumber'
- $ref: '#/components/parameters/pageSize'
responses:
'200':
description: A list of rule components.
content:
application/vnd.api+json:
# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-launch/refs/heads/main/openapi/adobe-launch-rule-components-api-openapi.yml