Adobe Suite Entities API

An entity is an Experience Data Model (XDM) object whose attributes and related time-series events have been merged from various sources to form an individual profile. For more information on using this set of endpoints, please read the [entities endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/profile/api/entities.html).

Operations 3

GET /ups/access/entities Retrieve an entity #
POST /ups/access/entities Retrieve multiple entities #
DELETE /ups/access/entities Delete an entity #

Documentation

📖
Documentation
https://developer.adobe.com/photoshop/api/docs/
📖
Authentication
https://developer.adobe.com/developer-console/docs/guides/authentication/
📖
Documentation
https://developer.adobe.com/lightroom/api/docs/
📖
Documentation
https://developer.adobe.com/illustrator/api/docs/
📖
Documentation
https://developer.adobe.com/indesign/docs/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/
📖
GettingStarted
https://developer.adobe.com/document-services/docs/overview/pdf-extract-api/gettingstarted/
📖
Documentation
https://developer.adobe.com/document-services/docs/overview/pdf-accessibility-auto-tag-api/
📖
Documentation
https://developer.adobe.com/analytics-apis/docs/
📖
APIReference
https://developer.adobe.com/analytics-apis/docs/2.0/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/
📖
APIReference
https://developer.adobe.com/firefly-services/docs/api/
📖
Documentation
https://developer.adobe.com/audio-video-firefly-services/
📖
GettingStarted
https://developer.adobe.com/audio-video-firefly-services/getting-started/
📖
Documentation
https://developer.adobe.com/creative-cloud-libraries/docs/
📖
APIReference
https://developer.adobe.com/creative-cloud-libraries/docs/api/
📖
Documentation
https://developer.adobe.com/express/embed-sdk/docs/guides/
📖
APIReference
https://developer.adobe.com/express/embed-sdk/docs/v4/
📖
GettingStarted
https://developer.adobe.com/express/embed-sdk/docs/guides/quickstart/
📖
Documentation
https://developer.adobe.com/experience-platform-apis/
📖
GettingStarted
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-guide
📖
Documentation
https://developer.adobe.com/marketo-apis/
📖
Authentication
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/authentication
📖
Documentation
https://developer.adobe.com/commerce/docs/
📖
GettingStarted
https://developer.adobe.com/commerce/webapi/get-started/
📖
Documentation
https://developer.adobe.com/experience-cloud/cloud-manager/
📖
Documentation
https://developer.adobe.com/journey-optimizer-apis/
📖
Documentation
https://developer.adobe.com/workfront-apis/
📖
Documentation
https://developer.adobe.com/firefly-services/docs/substance3d/
📖
Documentation
https://developer.adobe.com/data-collection-apis/
📖
Documentation
https://developer.adobe.com/adobe-status/
📖
Documentation
https://developer.adobe.com/vip-marketplace/

Specifications

Other Resources

🔗
Pricing
https://developer.adobe.com/document-services/pricing/
🔗
SDKs
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/sdks/
🔗
ReleaseNotes
https://developer.adobe.com/document-services/docs/overview/pdf-services-api/releasenotes
🔗
Guides
https://developer.adobe.com/analytics-apis/docs/2.0/guides/
🔗
Guides
https://developer.adobe.com/firefly-services/docs/guides/
🔗
Usage Notes
https://developer.adobe.com/audio-video-firefly-services/getting_started/usage/
🔗
Overview
https://developer.adobe.com/creative-cloud-libraries/docs/overview/
🔗
Integration Guide
https://developer.adobe.com/creative-cloud-libraries/docs/integrate/
🔗
API Fundamentals
https://experienceleague.adobe.com/en/docs/experience-platform/landing/platform-apis/api-fundamentals
🔗
Developer Guide
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
🔗
REST API
https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/rest/rest-api
🔗
REST API
https://developer.adobe.com/commerce/webapi/rest/
🔗
GraphQL API
https://developer.adobe.com/commerce/webapi/graphql-api/
🔗
REST API Reference
https://developer.adobe.com/commerce/webapi/reference/rest/paas/
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/graphql/adobe-suite-graphql.md
🔗
Webhooks
https://developer.adobe.com/experience-cloud/cloud-manager/guides/getting-started/create-event-integration/
🔗
StatusPage
https://status.adobe.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/adobe-suite-entities-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adobe-suite-entities-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Real-time Customer Profile Entities API
  description: "Use Real-time Customer Profile to drive coordinated, consistent and relevant experiences for your customers no matter where or when they interact with your brand. Profile provides a holistic view of each individual customer that combines data from multiple channels, including online, offline, CRM, and third-party data.\n- **Related documentation**:\n  - [Real-time Customer Profile documentation](http://www.adobe.com/go/profile-overview-en)\n  - [Profile API developer guide](http://www.adobe.com/go/profile-developer-guide-en)\n\n- **Visualize API calls with Postman (a free, third-party software)**:\n  - [Real-time Customer Profile API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Real-time%20Customer%20Profile%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  - Base path for the computed attributes API: /data/core/ca\n  - Example of a complete path: https://<span>platform.adobe.io/data/core/ups/config/mergePolicies\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/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`. Accepted values specific to each call are provided in the call parameters.\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).\n  "
  version: '1.0'
servers:
- url: https://{environment}.adobe.io/data/core
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Entities
  description: An entity is an Experience Data Model (XDM) object whose attributes and related time-series events have been merged from various sources to form an individual profile. For more information on using this set of endpoints, please read the [entities endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/profile/api/entities.html).
paths:
  /ups/access/entities:
    get:
      tags:
      - Entities
      summary: Retrieve an entity
      description: You can only use this endpoint if you are subscribed to Real-Time CDP Ultimate edition. For more information on this update, read the [entities API guide](https://experienceleague.adobe.com/en/docs/experience-platform/profile/api/entities).
      operationId: retrieveEntity
      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: schema.name
        in: query
        description: The name of the schema you want to retrieve. Please note that retrieving ExperienceEvents is now **deprecated**.
        required: true
        schema:
          type: string
          enum:
          - _xdm.context.profile
          - _xdm.context.account
          - _xdm.context.opportunity
        example: _xdm.context.profile
      - name: entityId
        in: query
        description: The ID of the entity. If the value of this parameter is not an XID, you must also provide the identity namespace parameter, `entityIdNS`.
        schema:
          type: string
        example: GtghAUFkdGVzdDE
      - name: entityIdNS
        in: query
        description: The identity namespace of the entity. This field is only used if you specified an `entityId`.
        schema:
          type: string
        example: UPS1
      - name: fields
        in: query
        description: Filters the data returned in the response. Use this to specify which schema field values to include in data retrieved. For multiple fields, separate values by a comma with no spaces between.
        schema:
          type: string
        example: person.name.firstName,person.name.lastName
      - name: mergePolicyId
        in: query
        description: Identifies the merge policy by which to govern the data returned. If one is not specified in the call, your organization's default for that schema will be used. If no default merge policy has been configured, the default is no profile merge and no identity stitching.
        schema:
          type: string
        example: example-mergePolicy
      - name: startTime
        in: query
        description: Inclusively specifies the start time to filter the entities (in milliseconds). By default, this is from beginning.
        schema:
          type: number
        example: '1539838505'
      - name: endTime
        in: query
        description: Exclusively specifies the end time to filter entities (in milliseconds). By default, this is to the end.
        schema:
          type: number
        example: '1539838510'
      - name: limit
        in: query
        description: The maximum number of records to return from the result. Only for time-series objects. By default, this value is set to 1000.
        schema:
          type: number
        example: 10
      - name: orderby
        in: query
        description: The sort order of retrieved entities by timestamp. This is written as `(+/-)timestamp`, with the default being `+timestamp`.
        schema:
          type: string
        example: -timestamp
      - name: property
        in: query
        description: 'Filter by the property value. Supported evaluators include =, !=, <, <=, >, >=. If more than one property filter is provided, it needs to be concatenated with `&`. This can only be used with experience events, with a maximum of **three** properties being supported. When using URLs, they must be encoded. When using date filters, they must be encoded as a string in the format "yyyy-mm-dd" or "yyyymmdd".<br><br>Example: `property=web.webPageDetails.isHomepage=false&property=placeContext.localTime<="2020-07-20"`'
        schema:
          type: string
        example: property=web.webPageDetails.isHomepage=false&property=placeContext.localTime<="2020-07-20"
      responses:
        200:
          x-summary: Success
          description: The entity was successfully returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntityResponse'
              examples:
                Profile entity:
                  value:
                    BVrqzwVv7o2p3naHvnsWpqZXv3KJgA:
                      entityId: BVrqzwVv7o2p3naHvnsWpqZXv3KJgA
                      sources:
                      - '1000000000'
                      entity:
                        identities:
                        - id: '89149270342662559642753730269986316601'
                          namespace:
                            code: ecid
                        - id: janedoe@example.com
                          namespace:
                            code: email
                        - id: '89149270342662559642753730269986316604'
                          namespace:
                            code: ecid
                        - id: janefdoeh@example.com
                          namespace:
                            code: email
                        - id: '58832431024964181144308914570411162539'
                          namespace:
                            code: ecid
                        - id: '89149270342662559642753730269986316602'
                          namespace:
                            code: ecid
                          primary: 'true'
                        person:
                          name:
                            firstName: Jane
                            middleName: F
                            lastName: Doe
                        workEmail:
                          primary: true
                          address: janedoe@example.com
                          label: Jane Doe
                          type: work
                          status: active
                      lastModifiedAt: '2018-10-18T15:59:10-08:00'
                B2B Account:
                  value:
                    GuQ-AUFjgjaeIw:
                      entityId: GuQ-AUFjgjaeIw
                      mergePolicy:
                        id: a6150f47-a94f-4c9d-bfa0-958a370020ee
                      sources:
                      - er_m_attr
                      entity:
                        _id: id1
                        extSourceSystemAudit:
                          lastReferencedDate: '2024-03-09 12:21:43.0'
                          lastActivityDate: '2024-03-09 12:21:43.0'
                          lastUpdatedDate: '2024-03-09 12:21:43.0'
                          lastUpdatedBy: '{USER_ID}'
                          externalKey:
                            sourceID: 00394S0001xpG6xABE
                            sourceKey: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                            sourceInstanceID: '{SOURCE_INSTANCE_ID}'
                            sourceType: '{SOURCE_TYPE}'
                          lastViewedDate: '2024-03-09 12:21:43.0'
                          createdDate: '2024-03-09 12:21:43.0'
                        accountID: '2334262'
                        identityMap:
                          b2b_account:
                          - id: '2334263'
                          - id: '2334262'
                          - id: '{SOURCE_ID}'
                        isDeleted: false
                        accountKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
                B2B Opportunity:
                  value:
                    Ggw_AUFjgjaeIw:
                      entityId: Ggw_AUFjgjaeIw
                      mergePolicy:
                        id: 162824be-07f5-4cd0-aa85-2ff3c8f6c775
                      sources:
                      - er_m_attr
                      entity:
                        _id: id1
                        extSourceSystemAudit:
                          lastReferencedDate: '2024-03-09 12:21:43.0'
                          lastActivityDate: '2024-03-09 12:21:43.0'
                          lastUpdatedDate: '2024-03-09 12:21:43.0'
                          lastUpdatedBy: '{USER_ID}'
                          externalKey:
                            sourceID: 00394S0001xpG6xABE
                            sourceKey: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                            sourceInstanceID: 00DC0000000Q35nMAC
                            sourceType: Salesforce
                          lastViewedDate: '2024-03-09 12:21:43.0'
                          createdDate: '2024-03-09 12:21:43.0'
                        accountID: '2334262'
                        identityMap:
                          b2b_opportunity:
                          - id: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                          - id: '2334263'
                          - id: '2334262'
                        isDeleted: false
                        opportunityKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
                        accountKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
        400:
          x-summary: Bad request
          description: The post body is incomplete. Please double check your post body and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorContext'
        403:
          x-summary: Missing access permissions
          description: You do not have access permissions for this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        404:
          x-summary: Not found
          description: XDM objects not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        422:
          x-summary: Processing error
          description: Syntax is correct but Profile Access is not able to process your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorContext'
        429:
          x-summary: Rate limit
          description: Too many requests were sent. Please try again later.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TooManyRequestError'
        500:
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseInternalErrorContext'
    post:
      tags:
      - Entities
      summary: Retrieve multiple entities
      description: You can only use this endpoint if you are subscribed to Real-Time CDP Ultimate edition. For more information on this update, read the [entities API guide](https://experienceleague.adobe.com/en/docs/experience-platform/profile/api/entities).
      operationId: retrieveMultipleEntities
      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: Content-Type
        in: header
        description: Type of content being sent in the body of the request. Should be 'application/json'.
        required: true
        schema:
          type: string
      requestBody:
        description: XDM objects to be created. Each object should be in JSON format.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRequestBodyEntity'
            examples:
              Profile entity:
                value:
                  schema:
                    name: _xdm.context.profile
                  fields:
                  - identities
                  - person.name
                  - workEmail
                  identities:
                  - entityId: '89149270342662559642753730269986316601'
                    entityIdNS:
                      code: ECID
                  - entityId: '89149270342662559642753730269986316900'
                    entityIdNS:
                      code: ECID
                  - entityId: '89149270342662559642753730269986316602'
                    entityIdNS:
                      code: ECID
                  timeFilter:
                    startTime: 1539838505
                    endTime: 1539838510
                  limit: 10
                  orderBy: -timestamp
              B2B Account:
                value:
                  schema:
                    name: _xdm.context.account
                  identities:
                  - entityId: '2334262'
                    entityIdNS:
                      code: b2b_account
                  - entityId: '2334263'
                    entityIdNS:
                      code: b2b_account
                  - entityId: '2334264'
                    entityIdNS:
                      code: b2b_account
              B2B Opportunity:
                value:
                  schema:
                    name: _xdm.context.opportunity
                  identities:
                  - entityId: '2334262'
                    entityIdNS:
                      code: b2b_opportunity
                  - entityId: '2334263'
                    entityIdNS:
                      code: b2b_opportunity
                  - entityId: '2334264'
                    entityIdNS:
                      code: b2b_opportunity
                  - entityId: '2334265'
                    entityIdNS:
                      code: b2b_opportunity
        required: true
      responses:
        200:
          x-summary: Success
          description: XDM objects successfully returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntityResponse'
              examples:
                Profile entity:
                  value:
                    BVrqzwVv7o2p3naHvnsWpqZXv3KJgA:
                      entityId: BVrqzwVv7o2p3naHvnsWpqZXv3KJgA
                      sources:
                      - '1000000000'
                      entity:
                        identities:
                        - id: '89149270342662559642753730269986316601'
                          namespace:
                            code: ecid
                        - id: janedoe@example.com
                          namespace:
                            code: email
                        - id: '89149270342662559642753730269986316604'
                          namespace:
                            code: ecid
                        - id: janefdoeh@example.com
                          namespace:
                            code: email
                        - id: '58832431024964181144308914570411162539'
                          namespace:
                            code: ecid
                        - id: '89149270342662559642753730269986316602'
                          namespace:
                            code: ecid
                          primary: 'true'
                        person:
                          name:
                            firstName: Jane
                            middleName: F
                            lastName: Doe
                        workEmail:
                          primary: true
                          address: janedoe@example.com
                          label: Jane Doe
                          type: work
                          status: active
                      lastModifiedAt: '2018-10-18T15:59:10-08:00'
                    A29cgveD5y64ezphxjUXNzcm:
                      entityId: A29cgveD5y64ezphxjUXNzcm
                      sources:
                      - '1000000000'
                      entity:
                        identities:
                        - id: '89149270342662559642753730269986316601'
                          namespace:
                            code: ecid
                          primary: true
                        - id: janedoe@example.com
                          namespace:
                            code: email
                        person:
                          name:
                            firstName: Jane
                            middleName: F
                            lastName: Doe
                        workEmail:
                          primary: true
                          address: janedoe@example.com
                          label: Jane Doe
                          type: work
                          status: active
                      lastModifiedAt: '2018-10-18T15:59:10-08:00'
                B2B Account:
                  value:
                    GuQ-AUFjgjeeIw:
                      requestedIdentity:
                        entityId: 2334263
                        entityIdNS:
                          code: b2b_account
                      entityId: GuQ-AUFjgjeeIw
                      mergePolicy:
                        id: a6150f47-a94f-4c9d-bfa0-958a370020ee
                      sources:
                      - er_m_attr
                      entity:
                        _id: id1
                        extSourceSystemAudit:
                          lastReferencedDate: '2024-03-09 12:21:43.0'
                          lastActivityDate: '2024-03-09 12:21:43.0'
                          lastUpdatedDate: '2024-03-09 12:21:43.0'
                          lastUpdatedBy: '{USER_ID}'
                          externalKey:
                            sourceID: 00394S0001xpG6xABE
                            sourceKey: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                            sourceInstanceID: 00DC0000000Q35nMAC
                            sourceType: Salesforce
                          lastViewedDate: '2024-03-09 12:21:43.0'
                          createdDate: '2024-03-09 12:21:43.0'
                        accountID: '2334262'
                        identityMap:
                          b2b_account:
                          - id: '2334263'
                          - id: '2334262'
                          - id: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                        isDeleted: false
                        accountKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
                    GuQ-AUFjgjaeIw:
                      requestedIdentity:
                        entityId: 2334263
                        entityIdNS:
                          code: b2b_account
                      entityId: GuQ-AUFjgjaeIw
                      mergePolicy:
                        id: a6150f47-a94f-4c9d-bfa0-958a370020ee
                      sources:
                      - er_m_attr
                      entity:
                        _id: id1
                        extSourceSystemAudit:
                          lastReferencedDate: '2024-03-09 12:21:43.0'
                          lastActivityDate: '2024-03-09 12:21:43.0'
                          lastUpdatedDate: '2024-03-09 12:21:43.0'
                          lastUpdatedBy: '{USER_ID}'
                          externalKey:
                            sourceID: 00394S0001xpG6xABE
                            sourceKey: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                            sourceInstanceID: 00DC0000000Q35nMAC
                            sourceType: Salesforce
                          lastViewedDate: '2024-03-09 12:21:43.0'
                          createdDate: '2024-03-09 12:21:43.0'
                        accountID: '2334262'
                        identityMap:
                          b2b_account:
                          - id: '2334263'
                          - id: '2334262'
                          - id: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                        isDeleted: false
                        accountKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
                B2B Opportunity:
                  value:
                    GuQ-AUFjgjeeIw:
                      requestedIdentity:
                        entityId: 2334263
                        entityIdNS:
                          code: b2b_opportunity
                      entityId: GuQ-AUFjgjeeIw
                      mergePolicy:
                        id: a6150f47-a94f-4c9d-bfa0-958a370020ee
                      sources:
                      - er_m_attr
                      entity:
                        _id: id1
                        extSourceSystemAudit:
                          lastReferencedDate: '2024-03-09 12:21:43.0'
                          lastActivityDate: '2024-03-09 12:21:43.0'
                          lastUpdatedDate: '2024-03-09 12:21:43.0'
                          lastUpdatedBy: '{USER_ID}'
                          externalKey:
                            sourceID: 00394S0001xpG6xABE
                            sourceKey: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                            sourceInstanceID: 00DC0000000Q35nMAC
                            sourceType: Salesforce
                          lastViewedDate: '2024-03-09 12:21:43.0'
                          createdDate: '2024-03-09 12:21:43.0'
                        accountID: '2334262'
                        identityMap:
                          b2b_opportunity:
                          - id: '2334263'
                          - id: '2334262'
                          - id: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                        isDeleted: false
                        opportunityKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
                        accountKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
                    GuQ-AUFjgjaeIw:
                      requestedIdentity:
                        entityId: 2334263
                        entityIdNS:
                          code: b2b_opportunity
                      entityId: GuQ-AUFjgjaeIw
                      mergePolicy:
                        id: a6150f47-a94f-4c9d-bfa0-958a370020ee
                      sources:
                      - er_m_attr
                      entity:
                        _id: id1
                        extSourceSystemAudit:
                          lastReferencedDate: '2024-03-09 12:21:43.0'
                          lastActivityDate: '2024-03-09 12:21:43.0'
                          lastUpdatedDate: '2024-03-09 12:21:43.0'
                          lastUpdatedBy: '{USER_ID}'
                          externalKey:
                            sourceID: 00394S0001xpG6xABE
                            sourceKey: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                            sourceInstanceID: 00DC0000000Q35nMAC
                            sourceType: Salesforce
                          lastViewedDate: '2024-03-09 12:21:43.0'
                          createdDate: '2024-03-09 12:21:43.0'
                        accountID: '2334262'
                        identityMap:
                          b2b_opportunity:
                          - id: '2334263'
                          - id: '2334262'
                          - id: 0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce
                        isDeleted: false
                        opportunityKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
                        accountKey:
                          sourceID: '2334262'
                          sourceKey: '2334262'
                          sourceInstanceID: '2334262'
                          sourceType: Random
        207:
          x-summary: Partial failure
          description: Failed to get records for some recordIds.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponseById'
        400:
          x-summary: Bad request
          description: The post body is incomplete. Please double check your post body and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorContext'
        403:
          x-summary: Missing access permissions
          description: You do not have access permissions for this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        404:
          x-summary: Not found
          description: XDM objects not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        429:
          x-summary: Rate limit
          description: Too many requests. Please try again later.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TooManyRequestError'
        500:
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseInternalErrorContext'
      x-codegen-request-body-name: body
    delete:
      tags:
      - Entities
      summary: Delete an entity
      operationId: deleteEntity
      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: schema.name
        in: query
        description: Name of the associated XDM schema. You can only use the _xdm.context.profile schema with this endpoint.
        required: true
        schema:
          type: string
        example: _xdm.context.profile
      - name: entityId
        in: query
        description: ID of the entity. For Native XID, use `entityId=<XID>` and leave `entityIdNS` absent; For ID:NS, use both `entityId` and `entityIdNS` fields.
        schema:
          type: string
        example: GtghAUFkdGVzdDE
      - name: entityIdNS
        in: query
        description: Identity Namespace code. Used for ID:NS. If this field is used, `entityId` cannot be empty.
        schema:
          type: string
        example: ECID
      - name: mergePolicyId
        in: query
        description: ID of the merge policy. A merge policy includes information for Identity stitching and key-value XDM object merging. If not present, the default merge policy will be used.
        schema:
          type: string
        example: 963d71a1-9875-4aea-a52b-c5c7a2504cae
      responses:
        202:
          x-summary: Accepted
          description: Accepted
          content: {}
        207:
          x-summary: Partial failure
          description: Failed to delete records with some IDs.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponseById'
        400:
          x-summary: Bad request
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseErrorContext'
        403:
          x-summary: Missing access permissions
          description: You do not have access permissions for this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        404:
          x-summary: Not found
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        429:
          x-summary: Rate limit
          description: Too many requests. Please try again later.
          content:
            application/json:
     

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