Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Adobe Launch Properties API
version: '1.0'
description: 'Operations tagged Properties across 2 of this provider''s published API definitions: adobe-launch-properties-api-openapi.yml, adobe-launch-reactor-api-published-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://reactor.adobe.io
description: Adobe Reactor API production gateway
- url: //reactor.adobe.io
tags:
- name: Properties
description: Manage event forwarding properties (edge platform).
paths:
/companies/{companyId}/properties:
servers:
- url: https://reactor.adobe.io
description: Adobe Reactor API production gateway
get:
operationId: listEventForwardingProperties
summary: List Event Forwarding Properties
description: Retrieve properties for a company, filtering by platform=edge to get event forwarding properties specifically.
tags:
- Properties
parameters:
- $ref: '#/components/parameters/companyId'
- name: filter[platform]
in: query
required: true
schema:
type: string
enum:
- edge
description: Filter to edge platform for event forwarding properties.
example: edge
- name: filter[name]
in: query
schema:
type: string
example: example_value
- name: filter[enabled]
in: query
schema:
type: boolean
example: true
- name: page[number]
in: query
schema:
type: integer
minimum: 1
example: 10
- name: page[size]
in: query
schema:
type: integer
minimum: 1
maximum: 100
example: 10
responses:
'200':
description: A list of event forwarding properties.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PropertyListResponse'
examples:
Listeventforwardingproperties200Example:
summary: Default listEventForwardingProperties 200 response
x-microcks-default: true
value:
data:
- id: abc123
type: properties
relationships: {}
meta:
pagination:
current_page: 10
next_page: 10
prev_page: 10
total_pages: 10
total_count: 10
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createEventForwardingProperty
summary: Create an Event Forwarding Property
description: Create a new edge property for event forwarding.
tags:
- Properties
parameters:
- $ref: '#/components/parameters/companyId'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PropertyCreateRequest'
examples:
CreateeventforwardingpropertyRequestExample:
summary: Default createEventForwardingProperty request
x-microcks-default: true
value:
data:
type: properties
attributes:
name: Example Title
platform: edge
responses:
'201':
description: Event forwarding property created successfully.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PropertySingleResponse'
examples:
Createeventforwardingproperty201Example:
summary: Default createEventForwardingProperty 201 response
x-microcks-default: true
value:
data:
id: abc123
type: properties
relationships: {}
'422':
$ref: '#/components/responses/UnprocessableEntity'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/properties/{propertyId}:
servers:
- url: https://reactor.adobe.io
description: Adobe Reactor API production gateway
get:
operationId: getEventForwardingProperty
summary: Retrieve an Event Forwarding Property
description: Look up a specific event forwarding property by its ID.
tags:
- Properties
parameters:
- $ref: '#/components/parameters/propertyId'
responses:
'200':
description: Property details.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PropertySingleResponse'
examples:
Geteventforwardingproperty200Example:
summary: Default getEventForwardingProperty 200 response
x-microcks-default: true
value:
data:
id: abc123
type: properties
relationships: {}
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
operationId: updateEventForwardingProperty
summary: Update an Event Forwarding Property
description: Update the attributes of an event forwarding property.
tags:
- Properties
parameters:
- $ref: '#/components/parameters/propertyId'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PropertyUpdateRequest'
examples:
UpdateeventforwardingpropertyRequestExample:
summary: Default updateEventForwardingProperty request
x-microcks-default: true
value:
data:
id: abc123
type: properties
attributes:
name: Example Title
enabled: true
responses:
'200':
description: Property updated successfully.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/PropertySingleResponse'
examples:
Updateeventforwardingproperty200Example:
summary: Default updateEventForwardingProperty 200 response
x-microcks-default: true
value:
data:
id: abc123
type: properties
relationships: {}
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteEventForwardingProperty
summary: Delete an Event Forwarding Property
description: Remove an event forwarding property. Returns HTTP 204 on success.
tags:
- Properties
parameters:
- $ref: '#/components/parameters/propertyId'
responses:
'204':
description: Property deleted successfully.
'404':
$ref: '#/components/responses/NotFound'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/properties/{propertyId}/company:
servers:
- url: https://reactor.adobe.io
description: Adobe Reactor API production gateway
get:
operationId: getCompanyForProperty
summary: Get the Company for a Property
description: Retrieve the company that owns the specified property.
tags:
- Properties
parameters:
- $ref: '#/components/parameters/propertyId'
responses:
'200':
description: Company details.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/CompanySingleResponse'
examples:
Getcompanyforproperty200Example:
summary: Default getCompanyForProperty 200 response
x-microcks-default: true
value:
data:
id: abc123
type: companies
relationships: {}
links:
self: https://www.example.com
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/companies/{COMPANY_ID}/properties:
servers:
- url: //reactor.adobe.io
get:
tags:
- Properties
summary: List a company's properties
description: '>**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League.'
operationId: listProperties
parameters:
- name: COMPANY_ID
in: path
description: The ID of the company whose properties 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: app_id
in: query
description: Filter by `app_id`.
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: copying
in: query
description: Filter by `copying`. This is a legacy attribute that is specific to properties that were migrated from the original Dynamic Tag Management (DTM) system to the current system. A `copying` property is a property that is populating its information from its original DTM implementation.
schema:
type: boolean
- name: enabled
in: query
description: Filter by `enabled`.
schema:
type: string
- name: platform
in: query
description: Filter by `platform`.
schema:
type: string
- name: token
in: query
description: Filter by `token`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns an array, listing the properties belonging to the specified company.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/propertiesListResponse'
post:
tags:
- Properties
summary: Create a new property
description: '>**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League.'
operationId: createProperty
parameters:
- 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
- name: COMPANY_ID
in: path
description: The ID of the company that you want to define the property under.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/createPropertyPayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/propertiesLookupResponse'
x-codegen-request-body-name: body
/properties/{PROPERTY_ID}:
servers:
- url: //reactor.adobe.io
get:
tags:
- Properties
summary: Retrieve a property
description: '>**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League.'
operationId: retrieveProperty
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property 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 property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/propertiesLookupResponse'
delete:
tags:
- Properties
summary: Delete a property
description: '>**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League.'
operationId: deleteProperty
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property 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:
- Properties
summary: Update a property
description: '>**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League.'
operationId: updateProperty
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property 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/propertiesUpdatePayload'
required: true
responses:
'200':
x-summary: Success
description: A successful response returns the details of the updated property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/propertiesUpdateResponse'
x-codegen-request-body-name: body
/properties/{PROPERTY_ID}/company:
servers:
- url: //reactor.adobe.io
get:
tags:
- Properties
summary: Retrieve the company that owns a property
description: '>**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League.'
operationId: retrievePropertyCompany
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property whose company 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
responses:
'200':
x-summary: Success
description: A successful response returns the details of the company that owns the property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/companiesLookupResponse'
/properties/{PROPERTY_ID}/callbacks:
servers:
- url: //reactor.adobe.io
get:
tags:
- Properties
summary: List a property's callbacks
description: '>**NOTE**: For more information on using this operation, see the [callbacks endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/callbacks.html) on Experience League.'
operationId: listCallbacks
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property whose callbacks 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
responses:
'200':
x-summary: Success
description: A successful response returns an array of callbacks belonging to the specified property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/callbacksListResponse'
post:
tags:
- Properties
summary: Create a new callback
description: '>**NOTE**: For more information on using this operation, see the [callbacks endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/callbacks.html) on Experience League.'
operationId: createCallback
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property that you want to create a callback 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/callbacksCreatePayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created callback.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/callbacksCreateResponse'
x-codegen-request-body-name: body
/properties/{PROPERTY_ID}/data_elements:
servers:
- url: //reactor.adobe.io
get:
tags:
- Properties
summary: List a property's data elements
description: '>**NOTE**: For more information on using this operation, see the [data elements endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/data-elements.html) on Experience League.'
operationId: listPropertyDataElements
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property whose data elements 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:
# --- truncated at 32 KB (172 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-launch/refs/heads/main/openapi/adobe-launch-properties-api-openapi.yml