Adobe Suite Audiences API

openapi: 3.2.0
info:
  title: Segmentation Service Audiences API
  description: "\nAdobe Experience Platform Segmentation Service provides a user interface and RESTful API that allows you to create audiences through segment definitions or other sources from your Real-Time Customer Profile data. These audiences are centrally configured and maintained on Platform, and are readily accessible by any Adobe solution. Use the Segmentation Service API to programmatically integrate the service's various functionalities into your experience application, providing RESTful endpoints for managing audiences, segment definitions, segment jobs, exports, schedules, and more.\n- **Related documentation**:\n    - [Segmentation Service documentation](https://www.adobe.com/go/segmentation-overview-en)\n\n- **Visualize API calls with Postman (a free, third-party software)**:\n    - [Segmentation Service API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Segmentation%20Service%20API.postman_collection.json)\n    - [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)\n    - [Steps for importing environments and collections in Postman](https://learning.getpostman.com/docs/postman/collection_runs/using_environments_in_collection_runs/)\n\n- **API paths**: \n  - PLATFORM Gateway URL: https://<span>platform.adobe.io/\n  - Base path for this API: /data/core/ups\n  - Example of a complete path: https://<span>platform.adobe.io/data/core/ups/segment/definitions\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](https://www.adobe.com/go/platform-api-authentication-en).\n  - All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of the sandbox the operation will take place in (for example, \\\"prod\\\"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en)for more information.    \n  - All requests with a payload in the request body(such as POST, PUT, and PATCH calls) must include the header `Content-Type` with a value of `application/json`.\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: //{environment}.adobe.io/data/core/ups
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Audiences
  description: Audiences are a set of people, accounts, households, or other entities that share common characteristics and behaviors. This set can be generated either by using Platform or from external sources. More information about using this set of endpoints can be found in the [audiences endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/segmentation/api/audiences.html).
paths:
  /audiences:
    get:
      tags:
      - Audiences
      summary: List audiences
      operationId: listAudiences
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: start
        in: query
        description: A query parameter that specifies the starting offset for the audiences returned.
        required: false
        schema:
          type: integer
        example: 4
      - name: limit
        in: query
        description: A query parameter that specifies the total number of audiences returned per page.
        required: false
        schema:
          type: integer
        example: 20
      - name: sort
        in: query
        description: A query parameter that specifies the field to sort the results by. This is written in the format `[attributeName]:[desc/asc]`
        required: false
        schema:
          type: string
        example: updateTime:desc
      - name: property
        in: query
        description: A query parameter that specifies which audiences to return. The audiences returned must **exactly** match the attribute value given. This is written in the format `property=[attributeName]==[attributeValue]`.
        required: false
        schema:
          type: string
        example: property=audienceId==test-audience-id
      - name: name
        in: query
        description: A query parameter that filters for audiences that contain the string in the name. This value is case **insensitive**.
        required: false
        schema:
          type: string
        example: Test
      - name: description
        in: query
        description: A query parameter that filters for audiences that contain the string in the description. This value is case **insensitive**.
        required: false
        schema:
          type: string
        example: Test description
      - name: entityType
        in: query
        description: A query parameter that lets you filter the type of audience you're looking for.
        required: false
        schema:
          type: string
        example: _xom.context.account
      responses:
        200:
          x-summary: Success
          description: A list of audiences is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudiencesList'
        403:
          x-summary: Missing access permissions
          description: Access is forbidden because the organization is **not** enabled for audiences.
          content:
            application/json:
              schema:
                type: object
              examples:
                Organization not enabled for audiences:
                  value:
                    requestId: dprgmrFdQgxPMLq5WxCRJsJUQcllxtHX
                    errors:
                      403:
                      - code: 403
                        message: The IMS Org is not enabled for External Segment.
                    type: https://ns.adobe.com/aep/errors/UPAPI-113740-403
                    title: The IMS Org is not enabled for External Segment
                    status: 403
                Attribute Based Access Control validation error:
                  value:
                    requestId: NvXUrBnbFxSQb00Uthy3rMIEFzNyRc2s
                    errors:
                      403:
                      - code: UPAPI-113752-403
                        message: Permission denied on some resources. errorMessage=[{\"resource\":{\"uri\":\"/orgs/{ORG_ID}/sandboxes/prod/segments\",\"labels\":[]},\"action\":\"READ\"}]
                      type: https://ns.adobe.com/aep/errors/UPAPI-113752-403
                      title: Permission denied on some resources. errorMessage=[{"resource":{"uri":"/orgs/{ORG_ID}/sandboxes/prod/segments","labels":[]},"action":"READ"}]
                      status: 403
    post:
      tags:
      - Audiences
      summary: Create an audience
      operationId: createAudience
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      requestBody:
        description: The request body for creating an audience.
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/CreatePlatformAudienceRequestBody'
            examples:
              Platform-generated audience:
                $ref: '#/components/examples/CreatePlatformAudienceRequestBody'
      responses:
        201:
          x-summary: Success
          description: A new audience was successfully created.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/PlatformGeneratedAudience'
              examples:
                Platform-generated audience:
                  $ref: '#/components/examples/PlatformAudience'
        400:
          x-summary: Error
          description: The audience could not be created.
          content:
            application/json:
              schema:
                type: object
              examples:
                Validation error (Name is a mandatory field):
                  value:
                    requestId: fggdhzT89v3qlldeezJ9eVQtKiR51hkZ
                    errors:
                      400:
                      - code: 400
                        message: There is a problem extracting the user JSON, field(s) missing or invalid.  Correct and try again.
                      - code: 400
                        message: No usable value for name\nDid not find value which can be converted into java.lang.String
                      - code: 400
                        message: Did not find value which can be converted into java.lang.String
                    type: https://ns.adobe.com/aep/errors/UPLIB-101206-500
                    title: There is a problem extracting the user JSON, field(s) missing or invalid. Correct and try again.
                    status: 400
                Validation error (Cannot create audience where lifecycle state is deleted):
                  value:
                    requestId: 2wvHvngaq58nE1JyNFOJwQjIQJV2dePE
                    errors:
                      400:
                      - code: 400
                        message: There is a problem in audience validation. Cannot set lifecycleState as deleted
                    type: https://ns.adobe.com/aep/errors/UPAPI-113434-400
                    title: There is a problem in audience validation. Cannot set lifecycleState as deleted
                    status: 400
                Validation error (Dataset ID validation):
                  value:
                    requestId: dki6o4NeG6sUAYd80tIfNFnTTMzq9TWk
                    errors:
                      400:
                      - code: 400
                        message: Dataset 15b4657a-058a-47b0-a356-7b63328138c6 cannot be retrieved from Catalog https://platform.adobe.io/data/foundation/catalog/dataSets/15b4657a-058a-47b0-a356-7b63328138c6.
                      - code: 400
                        message: 'uri:PlatformUrl/data/foundation/catalog/dataSets/15b4657a-058a-47b0-a356-7b63328138c6 -> Status Code - 404 : message

                          {"type":"/placeholder/type/uri","status":404,"title":"NotFoundError","detail":"DataSet not found."}'
                    type: https://ns.adobe.com/aep/errors/UPLIB-101554-503
                    title: Dataset 15b4657a-058a-47b0-a356-7b63328138c6 cannot be retrieved from Catalog https://platform.adobe.io/data/foundation/catalog/dataSets/15b4657a-058a-47b0-a356-7b63328138c6.
                    status: 400
  /audiences/{AUDIENCE_ID}:
    get:
      tags:
      - Audiences
      summary: Retrieve an audience
      operationId: getAudience
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: AUDIENCE_ID
        in: path
        description: The ID of the audience you want to retrieve.
        required: true
        schema:
          type: string
          example: 60ccea95-1435-4180-97a5-58af4aa285ab
      responses:
        200:
          x-summary: Success
          description: The specified audience was successfully retrieved.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/PlatformGeneratedAudience'
              examples:
                Platform-generated audience:
                  $ref: '#/components/examples/PlatformAudience'
        404:
          x-summary: Not found
          description: The audience was not found.
          content:
            application/json:
              schema:
                type: object
              examples:
                Audience not found:
                  value:
                    requestId: YrgXiqvCobA9neOmrzCP7kQLi4yIizoP
                    errors:
                      404:
                      - code: 404
                        message: The audience entity e65765df-adfa-4d4b-b31a-53c390a575c is not found. Use a valid entity and try again.
                    type: https://ns.adobe.com/aep/errors/UPAPI-113430-404
                    title: The audience entity e65765df-adfa-4d4b-b31a-53c390a575c is not found. Use a valid entity and try again.
                    status: 404
    delete:
      tags:
      - Audiences
      summary: Delete an audience
      operationId: deleteAudience
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: AUDIENCE_ID
        in: path
        description: The ID of the audience you want to retrieve.
        required: true
        schema:
          type: string
          example: 60ccea95-1435-4180-97a5-58af4aa285ab
      responses:
        204:
          x-summary: Success
          description: The audience was successfully deleted. No message is returned upon a successful response.
          content:
            application/json:
              schema:
                type: object
        400:
          x-summary: Error
          description: The audience could not be deleted.
          content:
            application/json:
              schema:
                type: object
              examples:
                Validation error (Audience is dependent on other audiences):
                  value:
                    requestId: JG5rthQiyy8Ca0Y0WnCbhCu6Rh2PT6bg
                    errors:
                      400:
                      - code: 400
                        message: The audience cannot be deleted.
                    type: https://ns.adobe.com/aep/errors/UPAPI-113631-403
                    title: The audience cannot be deleted.
                    status: 400
        403:
          x-summary: Missing access permissions
          description: Attribute based access control error
          content:
            application/json:
              schema:
                type: object
              examples:
                Could not re-write audience status:
                  value:
                    requestId: NvXUrBnbFxSQb00Uthy3rMIEFzNyRc2s
                    errors:
                      403:
                      - code: UPAPI-113752-403
                        message: Permission denied on some resources. errorMessage=[{\"resource\":{\"uri\":\"/orgs/660932FC5AFCB4C50A494209@AdobeOrg/sandboxes/prod/segments/60ccea95-1435-4180-97a5-58af4aa285ab5\",\"labels\":[]},\"action\":\"WRITE\"}]
                    type: https://ns.adobe.com/aep/errors/UPAPI-113752-403
                    title: Permission denied on some resources. errorMessage=[{\"resource\":{\"uri\":\"/orgs/660932FC5AFCB4C50A494209@AdobeOrg/sandboxes/prod/segments/60ccea95-1435-4180-97a5-58af4aa285ab5\",\"labels\":[]},\"action\":\"WRITE\"}]
                    status: 403
        404:
          x-summary: Not found
          description: The audience could not be found.
          content:
            application/json:
              schema:
                type: object
              examples:
                Audience not found:
                  value:
                    requestId: YrgXiqvCobA9neOmrzCP7kQLi4yIizoP
                    errors:
                      404:
                      - code: 404
                        message: The audience entity 60ccea95-1435-4180-97a5-58af4aa285ab5 is not found. Use a valid entity and try again.
                    type: https://ns.adobe.com/aep/errors/UPAPI-113430-404
                    title: The audience entity 60ccea95-1435-4180-97a5-58af4aa285ab5 is not found. Use a valid entity and try again.
                    status: 404
    patch:
      tags:
      - Audiences
      summary: Update one or more attributes of an audience
      operationId: patchAudience
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: AUDIENCE_ID
        in: path
        description: The ID of the audience you want to patch.
        required: true
        schema:
          type: string
          example: 60ccea95-1435-4180-97a5-58af4aa285ab
      requestBody:
        description: A sample request body to update the PQL expression of the audience.
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  op:
                    type: string
                    example: add
                  path:
                    type: string
                    example: /expression
                  value:
                    type: object
                    properties:
                      type:
                        type: string
                        example: PQL
                      format:
                        type: string
                        example: pql/text
                      value:
                        type: string
                        example: workAddress.country = "CA"
            examples:
              Update the PQL:
                description: The following PATCH request will update the audience's workAddress.country to US.
                value:
                - op: add
                  path: /expression
                  value:
                    type: PQL
                    format: pql/text
                    value: workAddress.country= "US"
      responses:
        201:
          x-summary: Success
          description: Details of your newly updated audience are returned.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/PlatformGeneratedAudience'
              examples:
                Update the PQL:
                  $ref: '#/components/examples/PlatformAudience'
        400:
          x-summary: Error
          description: The audience could not be updated.
          content:
            application/json:
              schema:
                type: object
              examples:
                Validation error (Lifecycle status cannot be modified to Delete):
                  value:
                    requestId: rxFGviFDXAfpH2qTzDta41sWoXHsuQpU
                    errors:
                      400:
                      - code: 400
                        message: There is a problem in audience validation. lifecycle field can not be modified to Delete using Patch operation
                    type: https://ns.adobe.com/aep/errors/UPAPI-113434-400
                    title: There is a problem in audience validation. lifecycle field can not be modified to Delete using Patch operation
                    status: 400
        404:
          x-summary: Not found
          description: The audience could not be found.
          content:
            application/json:
              schema:
                type: object
              examples:
                Audience not found:
                  value:
                    requestId: YrgXiqvCobA9neOmrzCP7kQLi4yIizoP
                    errors:
                      404:
                      - code: 404
                        message: The audience entity 4afe34ae-8c98-4513-8a1d-67ccaa54bc05 is not found. Use a valid entity and try again.
                    type: https://ns.adobe.com/aep/errors/UPAPI-113430-404
                    title: The audience entity 4afe34ae-8c98-4513-8a1d-67ccaa54bc05 is not found. Use a valid entity and try again.
                    status: 404
    put:
      tags:
      - Audiences
      summary: Update an audience
      operationId: updateAudience
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: AUDIENCE_ID
        in: path
        description: The ID of the audience you want to overwrite.
        required: true
        schema:
          type: string
          example: 60ccea95-1435-4180-97a5-58af4aa285ab
      responses:
        201:
          x-summary: Success
          description: The audience was successfully updated.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/PlatformGeneratedAudience'
              examples:
                Update audience PQL expression:
                  $ref: '#/components/examples/PlatformAudience'
        400:
          x-summary: Error
          description: The audience could not be updated.
          content:
            application/json:
              schema:
                type: object
              examples:
                Validation error (Namepsace is immutable):
                  value:
                    requestId: LBGnewEg2iOcx6TcTVEIy1e6fE6zAlHh
                    errors:
                      400:
                      - code: 400
                        message: There is a problem in audience validation. Namespace is immutable field.
                    type: https://ns.adobe.com/aep/errors/UPAPI-113434-400
                    title: There is a problem in audience validation. Namespace is immutable field
                    status: 400
        404:
          x-summary: Not found
          description: The audience was not found.
          content:
            application/json:
              schema:
                type: object
              examples:
                Audience not found:
                  value:
                    requestId: YrgXiqvCobA9neOmrzCP7kQLi4yIizoP
                    errors:
                      404:
                      - code: 404
                        message: The audience entity 4afe34ae-8c98-4513-8a1d-67ccaa54bc05 is not found. Use a valid entity and try again.
                    type: https://ns.adobe.com/aep/errors/UPAPI-113430-404
                    title: The audience entity 4afe34ae-8c98-4513-8a1d-67ccaa54bc05 is not found. Use a valid entity and try again.
                    status: 404
        500:
          x-summary: Access control validation error
          description: An attribute based access control validation error ocurred.
          content:
            application/json:
              schema:
                type: object
              examples:
                Validation error:
                  value:
                    requestId: oeoKKxNTV4HAUcTPfhWoz6nDYmghjIIu
                    errors:
                      500:
                      - code: UPAPI-113751-500
                        message: There is a problem validating Field Level Access Control.
                      - code: 500
                        message: '{"type":"http://ns.adobe.com/aep/errors/PDP-4041-403","title":"The user is not entitled to the specified organization. Please try again with a valid user.","status":403,"report":{"tenantInfo":{"sandboxName":"N/A","sandboxId":"N/A","imsOrgId":"745F37C35E4B776E0A49421B@AdobeOrg"},"additionalContext":{"request-id":"oeoKKxNTV4HAUcTPfhWoz6nDYmghjIIu"}},"error-chain":[{"serviceId":"Policy Decision Point","errorCode":"PDP-4041-403","invokingServiceId":"acp_core_unifiedProfile_feeds","unixTimeStampMs":1660925698164}]}'
                    type: https://ns.adobe.com/aep/errors/UPAPI-113751-500
                    title: here is a problem validating Field Level Access Control."
                    status: 500
      requestBody:
        description: The request body to update the audience.
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/UpdateAudienceName'
              - $ref: '#/components/schemas/UpdateAudiencePQL'
            examples:
              Update the audience name:
                $ref: '#/components/examples/UpdateAudienceName'
              Update the audience PQL:
                $ref: '#/components/examples/UpdateAudiencePQL'
  /audiences/bulk-get:
    post:
      tags:
      - Audiences
      summary: Retrieve multiple audiences
      operationId: bulkGetAudiences
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      requestBody:
        description: A sample request body to retrieve multiple audiences.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 72c393ea-caed-441a-9eb6-5f66bb1bd6cd
            example:
              ids:
              - id: 72c393ea-caed-441a-9eb6-5f66bb1bd6cd
              - id: QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075
      responses:
        207:
          x-summary: Success
          description: The audiences were successfully retrieved.
          content:
            application/json:
              schema:
                type: object
              examples:
                All the audiences were successfully retrieved:
                  value:
                    results:
                      72c393ea-caed-441a-9eb6-5f66bb1bd6cd:
                        id: 72c393ea-caed-441a-9eb6-5f66bb1bd6cd
                        audienceId: 72c393ea-caed-441a-9eb6-5f66bb1bd6cd
                        schema:
                          name: _xdm.context.profile
                        imsOrgId: '{ORG_ID}'
                        sandbox:
                          sandboxId: 6ed34f6f-fe21-4a30-934f-6ffe21fa3075
                          sandboxName: prod
                          type: production
                          default: true
                        name: Sample Audience
                        expression:
                          type: pql
                          format: pql/text
                          value: _id = \"abc\"
                        mergePolicyId: 87c94d51-239c-4391-932c-29c2412100e5
                        evaluationInfo:
                          batch:
                            enabled: false
                          continuous:
                            enabled: true
                          synchronous:
                            enabled: false
                        ansibleUiEnabled: false
                        dataGovernancePolicy:
                          excludeOptOut: true
                        creationTime: 1623889553000
                        createEpoch: 1623889553
                        updateTime: 1674646369000
                        updateEpoch: 1674646369
                        _etag: \"61030ec7-0000-0200-0000-63d113610000\"
                        dependents: []
                        definedOn:
                        - meta:resourceType: unions
                          meta:containerId: tenant
                          $ref: https://ns.adobe.com/xdm/context/profile__union
                        dependencies: []
                        type: SegmentDefinition
                        state: enabled
                        overridePerformanceWarnings: false
                        lastModifiedBy: '{USER_ID}'
                        lifecycleState: published
                        namespace: AEPSegments
                        isSystem: false
                        saveSegmentMembership: true
                        originName: REAL_TIME_CUSTOMER_PROFILE
                      QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075:
                        id: QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075
                        name: External Audience
                        namespace: AO
                        imsOrgId: '{ORG_ID}'
                        sandbox:
                          sandboxId: 6ed34f6f-fe21-4a30-934f-6ffe21fa3075
                          sandboxName: prod
                          type: production
                          default: true
                        type: ExternalSegment
                        lifecycleState: published
                        sourceId: source-id
                        createdBy: '{USER_ID}'
                        datasetId: 62bf31a105e9891b63525c92
                        _etag: \"3100da6d-0000-0200-0000-62bf31a10000\"
                        creationTime: 1656697249000
                        createEpoch: 1656697249
                        updateTime: 1656697249000
                        updateEpoch: 1656697249
                        audienceId: external-audience-id
                        isSystem: false
                        saveSegmentMembership: true
                        linkedAudienceRef:
                          aoWorkflowId: 62bf31858e87e34c8364befa
                        originName: AUDIENCE_ORCHESTRATION
                One audience was not found:
                  value:
                    results:
                      QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075:
                        id: QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075
                        name: External Audience
                        namespace: AO
                        imsOrgId: '{ORG_ID}'
                        sandbox:
                          sandboxId: 6ed34f6f-fe21-4a30-934f-6ffe21fa3075
                          sandboxName: prod
                          type: production
                          default: true
                        type: ExternalSegment
                        lifecycleStatus: published
                        sourceId: source-id
                        createdBy: '{USER_ID}'
                        datasetId: 62bf31a105e9891b63525c92
                        _etag: \"3100da6d-0000-0200-0000-62bf31a10000\"
                        creationTime: 1656697249000
                        createEpoch: 1656697249
                        updateTime: 1656697249000
                        updateEpoch: 1656697249
                        audienceId: test-audience-id
                        isSystem: false
                        saveSegmentMembership: true
                        linkedAudienceRef:
                          aoWorkflowId: 62bf31858e87e34c8364befa
                        originName: AUDIENCE_ORCHESTRATION
                      missing-audience:
                        requestId: BNcYkjG1BCnhQ51uToeSdY5D5fQOKcSe
                        errors:
                          404:
                          - code: 404
                            message: Not found.
        400:
          x-summary: Error
          description: An invalid number of IDs was requested. This value **must** be greater than 100 and less than 1000.
          content:
            application/json:
              schema:
                type: object
              examples:
                No IDs were provided:
                  value:
                    requestId: 6qtdW3er5YruNle8CfFa050FlIuKsEZb
                    errors:
                      400:
                      - code: UPAPI-113015-400
                        message: The number of 

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-audiences-api-openapi.yml