Conversion Full Delete API

openapi: 3.2.0
info:
  title: Conversion Full Delete API
  version: 2.0.0
  description: The Conversion API lets you programmatically manage contacts, track custom events, and manage their associated data.
servers:
- url: https://pub-api.conversion.ai/api
security:
- apiKey: []
- apiKeyQuery: []
tags:
- name: Full Delete
paths:
  /v2/full-delete:
    post:
      operationId: fullDelete
      summary: Full Delete Contact
      description: 'Permanently delete a contact and suppress its identifiers for GDPR and CCPA erasure requests.


        Identify the contact with `email`, `cnvContactId`, or `userId`. At least one is required.


        A full delete removes the contact''s personal data and engagement data as described in Data deletion, then suppresses the provided identifiers so the contact is not re-created.


        Deletion is permanent and cannot be reversed.


        > **Request access.** This endpoint is not enabled by default, contact the Conversion team to request access. Calls from accounts without it return `403 export_not_enabled`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                  description: The contact's email address. At least one of `email`, `cnvContactId`, or `userId` is required.
                  examples:
                  - jane@example.com
                cnvContactId:
                  type: string
                  format: uuid
                  description: The Conversion contact ID. At least one of `email`, `cnvContactId`, or `userId` is required.
                  examples:
                  - a1b2c3d4-e5f6-7890-abcd-ef1234567890
                userId:
                  type: string
                  description: The external user identifier for the contact, as passed to the Events endpoints. At least one of `email`, `cnvContactId`, or `userId` is required.
                  examples:
                  - user_12345
            examples:
              by-email:
                summary: Delete by email
                value:
                  email: jane@example.com
              by-contact-id:
                summary: Delete by contact ID
                value:
                  cnvContactId: a1b2c3d4-e5f6-7890-abcd-ef1234567890
              by-user-id:
                summary: Delete by user ID
                value:
                  userId: user_12345
      responses:
        '204':
          description: The contact was deleted and its identifiers suppressed. The response has no body.
        '400':
          description: The request was malformed or contained invalid data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                missing-identifier:
                  summary: Missing identifier
                  value:
                    error:
                      code: missing_identifier
                      message: one of 'email', 'cnvContactId', or 'userId' is required
        '401':
          description: Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  summary: Missing or invalid API key
                  value:
                    error:
                      code: unauthorized
                      message: API key is required
        '403':
          description: The full delete API is not enabled for this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                export-not-enabled:
                  summary: Full delete not enabled
                  value:
                    error:
                      code: export_not_enabled
                      message: business is not authorized to use the full delete API
        '500':
          description: An unexpected server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                internal:
                  summary: Internal error
                  value:
                    error:
                      code: internal_error
                      message: failed to delete contact
      tags:
      - Full Delete
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              description: A machine-readable error code.
              examples:
              - invalid_email
            message:
              type: string
              description: A human-readable error description.
              examples:
              - 'invalid email format: not-an-email'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Your Conversion API key. Found in **Settings > Integrations** in the dashboard. Format: `sk_live_<key_id>_<secret>`.'
    apiKeyQuery:
      type: apiKey
      in: query
      name: api_key
      description: 'Your Conversion API key, sent as a query parameter instead of the `X-API-Key` header. Prefer the header: URLs can end up in logs and browser history.'