> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeotap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete user profiles

> Deletes one or more user profiles based on Primary IDs or UCIDs.
Supports bulk deletion up to 400 profiles.
Requires API Key or Okta JWT authentication.




## OpenAPI

````yaml /profileapi.yaml post /cdp/v1/users/_delete
openapi: 3.0.3
info:
  title: Zeotap Profile API
  description: |
    Zeotap CDP Profile API.

    The api supports two authentication mechanisms (API Key and Okta JWT)
    and exposes profile write, search, and delete operations.
  version: 1.0.0
servers:
  - url: https://api.zeotap.com
security: []
tags:
  - name: Profile
    description: CDP User Profile operations
paths:
  /cdp/v1/users/_delete:
    post:
      tags:
        - Profile
      summary: Delete user profiles
      description: |
        Deletes one or more user profiles based on Primary IDs or UCIDs.
        Supports bulk deletion up to 400 profiles.
        Requires API Key or Okta JWT authentication.
      operationId: deleteProfiles
      parameters:
        - $ref: '#/components/parameters/Scopes'
        - $ref: '#/components/parameters/OrgId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteProfileRequest'
            examples:
              BulkDelete:
                value:
                  orgId: 1539
                  region: EU
                  ids:
                    AdId:
                      - mock_adid_1
                      - mock_adid_2
                  sendEmailNotification: false
      responses:
        '200':
          description: Profiles deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteProfileResponse'
        '400':
          description: Bad Request (invalid IDs, region mismatch, or limit exceeded)
        '401':
          description: Unauthorized – invalid or missing credentials
        '403':
          description: Forbidden – insufficient scopes
      security:
        - ApiKeyAuth: []
        - OktaJwt: []
components:
  parameters:
    Scopes:
      name: scopes
      in: header
      required: true
      description: |
        Comma-separated list of granted scopes.
        Allowed values: `profile.read`, `profile.write`, `profile.delete`
      schema:
        type: string
        example: profile.read,profile.write,profile.delete
    OrgId:
      name: orgId
      in: header
      required: false
      description: |
        Zeotap organisation ID. Required when using Okta JWT authentication.
      schema:
        type: integer
        example: 1577
  schemas:
    DeleteProfileRequest:
      type: object
      required:
        - orgId
        - region
        - ids
      properties:
        orgId:
          type: integer
          description: Organisation identifier
          example: 1539
        region:
          type: string
          description: Region code to scope the deletion
          example: EU
        ids:
          type: object
          description: >
            Map containing exactly ONE identifier type with an array of values
            to delete.

            Supports up to 400 IDs per API call.
          additionalProperties:
            type: array
            items:
              type: string
          example:
            AdId:
              - ddd682ec-bbe9-4705-bb02-3b9eacaf93bf
        sendEmailNotification:
          type: boolean
          default: false
          description: Whether to trigger an email notification upon deletion.
    DeleteProfileResponse:
      type: object
      properties:
        ucids:
          type: array
          items:
            type: string
          description: UCIDs of profiles that were processed
        deletedProfiles:
          type: array
          items:
            type: string
          description: UCIDs of profiles successfully deleted
        profilesNotFound:
          type: array
          items:
            type: string
          description: UCIDs or IDs that could not be matched to any profile
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Long-lasting client key
    OktaJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Okta-issued JWT passed in the Authorization header

````