LiveRamp Activation API

# generated by Reslang v6.2.5
openapi: 3.0.1
info:
  title: Activation API
  description: An API for destination management and segment delivery
  version: 2.9.0
servers:
  - description: Production API server
    url: 'https://api.liveramp.com/activation'
tags:
  - name: Explore Destinations
    description: View Destinations and Integrations where you can distribute data
  - name: Configure Distributions
    description: ''
  - name: Distribute Data
    description: ''
  - name: View Deliveries
    description: ''
  - name: OAuth Configuration
    description: ''
  - name: View Segments
    description: ''
  - name: v2/SegmentStatus
    description: (resource)  Represents a segment's status
paths:
  /v2/deliveries:
    get:
      tags:
        - View Deliveries
      operationId: Get v2/Deliveries
      description: ''
      summary: Fetch a list of Deliveries
      responses:
        '200':
          description: v2/Deliveries retrieved successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2DeliveryMultiResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: query
          name: limit
          description: Number of v2/Deliveries to return
          schema:
            type: integer
            format: int32
            default: 10
            minimum: 1
            maximum: 100
        - in: query
          name: after
          description: >-
            This value is a cursor that enables continued paginated queries. Its
            value can be found under "_pagination.after" in the previous
            response from this endpoint.
          schema:
            type: string
        - in: query
          name: integrationConnectionID
          required: false
          schema:
            type: string
            description: Link to v2/IntegrationConnection resource via its id
        - in: query
          name: segmentIDs
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  /v2/destinations:
    get:
      tags:
        - Explore Destinations
      operationId: Get v2/Destinations
      description: ''
      summary: Fetch a list of Destinations
      responses:
        '200':
          description: v2/Destinations retrieved successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2DestinationMultiResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: query
          name: limit
          description: Number of v2/Destinations to return
          schema:
            type: integer
            format: int32
            default: 10
            minimum: 1
            maximum: 100
        - in: query
          name: after
          description: >-
            This value is a cursor that enables continued paginated queries. Its
            value can be found under "_pagination.after" in the previous
            response from this endpoint.
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  '/v2/destinations/{id}':
    get:
      tags:
        - Explore Destinations
      operationId: Get v2/Destination
      description: ''
      summary: Fetch a single Destination
      responses:
        '200':
          description: v2/Destination retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2DestinationOutput'
        '404':
          description: v2/Destination not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  '/v2/destinations/{v2DestinationId}/integrations':
    get:
      tags:
        - Explore Destinations
      operationId: 'Get v2/Destination::Integrations'
      description: ''
      summary: Fetch a list of Integrations within a Destination
      responses:
        '200':
          description: Integrations retrieved successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2DestinationIntegrationMultiResponse'
        '404':
          description: Parent resource(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: v2DestinationId
          description: Id of parent v2/Destination
          required: true
          schema:
            type: string
        - in: query
          name: limit
          description: Number of Integrations to return
          schema:
            type: integer
            format: int32
            default: 10
            minimum: 1
            maximum: 100
        - in: query
          name: after
          description: >-
            This value is a cursor that enables continued paginated queries. Its
            value can be found under "_pagination.after" in the previous
            response from this endpoint.
          schema:
            type: string
        - in: query
          name: type
          required: false
          schema:
            allOf:
              - $ref: '#/components/schemas/IntegrationType'
            type: string
        - in: query
          name: view
          required: false
          schema:
            allOf:
              - $ref: '#/components/schemas/IntegrationView'
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  '/v2/destinations/{v2DestinationId}/integrations/{id}':
    get:
      tags:
        - Explore Destinations
      operationId: 'Get v2/Destination::Integration'
      description: ''
      summary: Fetch a single Integration
      responses:
        '200':
          description: Integration retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2DestinationIntegrationOutput'
        '404':
          description: Integration or parent resource(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: v2DestinationId
          description: Id of parent v2/Destination
          required: true
          schema:
            type: string
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  /v2/distribution-managers:
    post:
      tags:
        - Configure Distributions
      operationId: Create v2/DistributionManager
      description: ''
      summary: Create a Distribution Manager
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v2DistributionManagerInput'
      responses:
        '201':
          description: v2/DistributionManager created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
    get:
      tags:
        - Configure Distributions
      operationId: Get v2/DistributionManagers
      description: ''
      summary: Fetch a list of Distribution Managers
      responses:
        '200':
          description: v2/DistributionManagers retrieved successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2DistributionManagerMultiResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: query
          name: limit
          description: Number of v2/DistributionManagers to return
          schema:
            type: integer
            format: int32
            default: 10
            minimum: 1
            maximum: 100
        - in: query
          name: after
          description: >-
            This value is a cursor that enables continued paginated queries. Its
            value can be found under "_pagination.after" in the previous
            response from this endpoint.
          schema:
            type: string
        - in: query
          name: integrationConnectionID
          required: false
          schema:
            type: string
            description: Link to v2/IntegrationConnection resource via its id
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  '/v2/distribution-managers/{id}':
    get:
      tags:
        - Configure Distributions
      operationId: Get v2/DistributionManager
      description: ''
      summary: Fetch a single Distribution Manager
      responses:
        '200':
          description: v2/DistributionManager retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2DistributionManagerOutput'
        '404':
          description: v2/DistributionManager not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
    put:
      tags:
        - Configure Distributions
      operationId: Modify v2/DistributionManager
      description: ''
      summary: Update a Distribution Manager
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v2DistributionManagerPuttable'
      responses:
        '200':
          description: v2/DistributionManager modified successfully
        '404':
          description: v2/DistributionManager not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
    delete:
      tags:
        - Configure Distributions
      operationId: Delete v2/DistributionManager
      description: ''
      summary: Delete a Distribution Manager
      responses:
        '200':
          description: v2/DistributionManager deleted successfully
        '404':
          description: v2/DistributionManager not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  '/v2/distribution-managers/{v2DistributionManagerId}/segment-configs':
    post:
      tags:
        - Distribute Data
      operationId: 'Create v2/DistributionManager::SegmentConfigs'
      description: ''
      summary: >-
        Add Segments to a Distribution Manager. Limited to 500 segments at a
        time.
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/v2DistributionManagerSegmentConfigInput'
      responses:
        '207':
          description: 'SegmentConfig resources processed, statuses in body'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    status:
                      $ref: '#/components/schemas/StandardError'
        '404':
          description: Parent resource(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: v2DistributionManagerId
          description: Id of parent v2/DistributionManager
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
    delete:
      tags:
        - Distribute Data
      operationId: 'Delete v2/DistributionManager::SegmentConfigs'
      description: ''
      summary: >-
        Remove Segments from a Distribution Manager. Limited to 500 segments at
        a time.
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
      responses:
        '207':
          description: 'SegmentConfig deletes processed, statuses in body'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    status:
                      $ref: '#/components/schemas/StandardError'
        '404':
          description: Parent resource(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: v2DistributionManagerId
          description: Id of parent v2/DistributionManager
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
    get:
      tags:
        - Distribute Data
      operationId: 'Get v2/DistributionManager::SegmentConfigs'
      description: ''
      summary: Fetch a list of Segments within a Distribution Manager
      responses:
        '200':
          description: SegmentConfigs retrieved successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/v2DistributionManagerSegmentConfigMultiResponse
        '404':
          description: Parent resource(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: v2DistributionManagerId
          description: Id of parent v2/DistributionManager
          required: true
          schema:
            type: string
        - in: query
          name: limit
          description: Number of SegmentConfigs to return
          schema:
            type: integer
            format: int32
            default: 10
            minimum: 1
            maximum: 100
        - in: query
          name: after
          description: >-
            This value is a cursor that enables continued paginated queries. Its
            value can be found under "_pagination.after" in the previous
            response from this endpoint.
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  '/v2/distribution-managers/{v2DistributionManagerId}/segment-configs/{id}':
    get:
      tags:
        - Distribute Data
      operationId: 'Get v2/DistributionManager::SegmentConfig'
      description: ''
      summary: Fetch a single Segment within a Distribution Manager
      responses:
        '200':
          description: SegmentConfig retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2DistributionManagerSegmentConfigOutput'
        '404':
          description: SegmentConfig or parent resource(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: v2DistributionManagerId
          description: Id of parent v2/DistributionManager
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
        - in: path
          name: id
          required: true
          schema:
            type: string
  /v2/integration-connections:
    post:
      tags:
        - Configure Distributions
      operationId: Create v2/IntegrationConnection
      description: ''
      summary: Create an Integration Connection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v2IntegrationConnectionInput'
      responses:
        '201':
          description: v2/IntegrationConnection created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
    get:
      tags:
        - Configure Distributions
      operationId: Get v2/IntegrationConnections
      description: ''
      summary: Fetch a list of Integration Connections
      responses:
        '200':
          description: v2/IntegrationConnections retrieved successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2IntegrationConnectionMultiResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: query
          name: limit
          description: Number of v2/IntegrationConnections to return
          schema:
            type: integer
            format: int32
            default: 10
            minimum: 1
            maximum: 100
        - in: query
          name: after
          description: >-
            This value is a cursor that enables continued paginated queries. Its
            value can be found under "_pagination.after" in the previous
            response from this endpoint.
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  '/v2/integration-connections/{id}':
    get:
      tags:
        - Configure Distributions
      operationId: Get v2/IntegrationConnection
      description: ''
      summary: Fetch a single Integration Connection
      responses:
        '200':
          description: v2/IntegrationConnection retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2IntegrationConnectionOutput'
        '404':
          description: v2/IntegrationConnection not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
    put:
      tags:
        - Configure Distributions
      operationId: Modify v2/IntegrationConnection
      description: ''
      summary: Update an Integration Connection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v2IntegrationConnectionPuttable'
      responses:
        '200':
          description: v2/IntegrationConnection modified successfully
        '404':
          description: v2/IntegrationConnection not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
    delete:
      tags:
        - Configure Distributions
      operationId: Delete v2/IntegrationConnection
      description: ''
      summary: Delete an Integration Connection
      responses:
        '200':
          description: v2/IntegrationConnection deleted successfully
        '404':
          description: v2/IntegrationConnection not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: >-
            Bearer Authorization using the access token generated with your
            service account
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: >-
            LiveRamp Org ID to make requests as. Starting Jan 2022, this is
            recommended over the Liveramp Customer ID header
          in: header
          name: LR-Org-ID
          required: true
          schema:
            type: string
  /v2/oauth-connections:
    get:
      tags:
        - OAuth Configuration
      operationId: Get v2/OauthConnections
      description: ''
      summary: Fetch a list of OAuth Connections
      responses:
        '200':
          description: v2/OauthConnections retrieved successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2OauthConnectionMultiResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardError'
      parameters:
        - in: query
          name: limit
          description: Number of v2/OauthConnections to return
          schema:
            type: integer
            format: int32
            default: 10
            minimum: 1
            maximum: 100
        - in: query
          name: after
          description: >-
            This value is a cursor that enables continued paginated queries. Its
            value can be found under "_pagination.after" in the previous
            response from this endpoint.
       

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/liveramp/refs/heads/main/openapi/liveramp-activation-api-openapi.yml