Adobe Campaign Privacy API

openapi: 3.1.0
info:
  title: Adobe Campaign Classic Custom Resources Privacy API
  description: SOAP-based API for Adobe Campaign Classic v7 and v8, documented as HTTP POST operations. All operations target the single SOAP router endpoint at /nl/jsp/soaprouter.jsp and are differentiated by the SOAPAction header. Provides programmatic access to session management, data querying, record persistence, delivery management, workflow control, subscription management, and real-time transactional event ingestion.
  version: 8.0.0
  contact:
    name: Adobe Developer Support
    url: https://developer.adobe.com/
  license:
    name: Proprietary
    url: https://www.adobe.com/legal/terms.html
  x-logo:
    url: https://www.adobe.com/content/dam/cc/icons/adobe-campaign.svg
servers:
- url: https://{instance}.campaign.adobe.com
  description: Campaign Classic Instance
  variables:
    instance:
      description: Your Campaign Classic instance name
      default: YOUR_INSTANCE
tags:
- name: Privacy
  description: Create GDPR and CCPA privacy access and deletion requests for data subject compliance.
paths:
  /privacy/privacyTool:
    post:
      operationId: createPrivacyRequest
      summary: Adobe Campaign Create a Privacy Request
      description: Creates a GDPR or CCPA privacy request for data access or deletion. Supports both access requests (retrieve all data for a data subject) and delete requests (remove all data for a data subject).
      tags:
      - Privacy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrivacyRequest'
      responses:
        '201':
          description: Privacy request created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivacyRequestResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    InternalError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication failed. Invalid or expired OAuth token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error_code:
          type: string
          description: Numeric error code.
          example: example_value
        message:
          type: string
          description: Human-readable error message.
          example: example_value
    PrivacyRequest:
      type: object
      required:
      - name
      - namespaceName
      - reconciliationValue
      - regulation
      - type
      properties:
        name:
          type: string
          description: Name identifying the privacy request.
          example: Example Campaign
        namespaceName:
          type: string
          description: The namespace name used to identify the data subject (e.g., email, phone).
          example: Example Campaign
        reconciliationValue:
          type: string
          description: The value used to look up the data subject in the specified namespace (e.g., the email address).
          example: example_value
        regulation:
          type: string
          enum:
          - gdpr
          - ccpa
          description: The privacy regulation for the request.
          example: gdpr
        type:
          type: string
          enum:
          - access
          - delete
          description: Whether to access or delete the data subject data.
          example: access
    PrivacyRequestResponse:
      type: object
      properties:
        PKey:
          type: string
          description: The PKEY of the created privacy request.
          example: example_value
        status:
          type: string
          description: Current status of the privacy request.
          example: active
  securitySchemes:
    SessionToken:
      type: apiKey
      in: header
      name: X-Security-Token
      description: Security token obtained from xtk:session#Logon. Must be passed alongside the session token cookie (__sessiontoken) on all authenticated requests. Tokens have a 24-hour lifecycle.
externalDocs:
  description: Campaign Classic SOAP Web Services Documentation
  url: https://experienceleague.adobe.com/docs/campaign-classic/using/configuring-campaign-classic/api/web-service-calls.html