Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Reactor Notes API
description: "Use the Reactor API to programmatically manage resources and develop tag extensions in Adobe Experience Platform.\n**Related documentation**:\n * [Tags overview and UI documentation](https://adobe.com/go/launch_help_en)\n * [Reactor API guides](https://adobe.com/go/reactor-api-overview)\n\n**API paths**:\n * Reactor Gateway URL: https://<span>reactor.adobe.io\n * Example of a complete path for making a call to `/properties`: https://<span>reactor.adobe.io/properties\n\n**Required headers**:\n * All calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).\n * All GET requests to the Reactor API require an `Accept` header to determine what data is returned by the system. In most cases, this value will be `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).\n * All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header `Content-Type`. The specific `Content-Type` value for each call is provided in the parameters sections in the endpoints listed below.\n\n- **API error handling**:\n - Refer to the Experience Platform API troubleshooting guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#request-header-errors)."
version: '1.0'
servers:
- url: //reactor.adobe.io
tags:
- name: Notes
description: Notes are textual annotations that you can add to certain tag resources, such as data elements, extensions, libraries, properties, rules, and rule components.
paths:
/notes/{NOTE_ID}:
get:
tags:
- Notes
summary: Retrieve a note
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: retrieveNote
parameters:
- name: NOTE_ID
in: path
description: The ID of the note 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 note.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/notesLookupResponse'
/properties/{PROPERTY_ID}/notes:
get:
tags:
- Notes
summary: List a property'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: listPropertyNotes
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property 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 an array of notes belonging to the specified property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/propertiesNotesListResponse'
post:
tags:
- Notes
summary: Create a note for a property
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: createPropertyNote
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property 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/propertiesNotesCreatePayload'
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/propertiesNotesCreateResponse'
x-codegen-request-body-name: body
/data_elements/{DATA_ELEMENT_ID}/notes:
get:
tags:
- Notes
summary: List a data element'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: listDataElementNotes
parameters:
- name: DATA_ELEMENT_ID
in: path
description: The ID of the data element 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: 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 an array of notes belonging to the specified data element.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/dataElementsNotesListResponse'
post:
tags:
- Notes
summary: Create a note for a data element
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: createNote
parameters:
- name: DATA_ELEMENT_ID
in: path
description: The ID of the data element 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/dataElementsNotesCreatePayload'
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/dataElementsNotesCreateResponse'
x-codegen-request-body-name: body
/secrets/{SECRET_ID}/notes:
get:
tags:
- Notes
summary: List a secret'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: listSecretNotes
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret 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: 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 an array of notes belonging to the specified secret.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsNotesListResponse'
post:
tags:
- Notes
summary: Create a note for a secret
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: createSecretNote
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret 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/secretsNotesCreatePayload'
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/secretsNotesCreateResponse'
x-codegen-request-body-name: body
/extensions/{EXTENSION_ID}/notes:
get:
tags:
- Notes
summary: List an extension'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: listExtensionNotes
parameters:
- name: EXTENSION_ID
in: path
description: The ID of the extension 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
responses:
'200':
x-summary: Success
description: A successful response returns an array of notes that are attached to the specified extension.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/extensionsNotesListResponse'
post:
tags:
- Notes
summary: Create a note for an extension
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: createExtensionNote
parameters:
- name: EXTENSION_ID
in: path
description: The ID of the extension 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/extensionsNotesCreatePayload'
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/extensionsNotesCreateResponse'
x-codegen-request-body-name: body
/libraries/{LIBRARY_ID}/notes:
get:
tags:
- Notes
summary: List a library'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: listLibraryNotes
parameters:
- name: LIBRARY_ID
in: path
description: The ID of the library 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 them library.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/librariesNotesListResponse'
post:
tags:
- Notes
summary: Create a note for a library
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: createLibraryNote
parameters:
- name: LIBRARY_ID
in: path
description: The ID of the library 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/librariesNotesCreatePayload'
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/librariesNotesCreateResponse'
x-codegen-request-body-name: body
/rules/{RULE_ID}/notes:
get:
tags:
- Notes
summary: List a rule'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: listRuleNotes
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-launch/refs/heads/main/openapi/adobe-launch-notes-api-openapi.yml