Listrak Forget API

openapi: 3.2.0
info:
  version: v1
  title: Listrak Privacy REST Forget API
  description: '# Introduction

    Welcome to the Listrak Privacy REST API!'
  x-logo:
    url: /privacy/Resources/Images/Logo.png
servers:
- url: https://api.listrak.com/privacy
tags:
- name: Forget
  description: A Forget resource is used to submit and view the status of forget requests.
paths:
  /v1/Forget/{requestId}:
    get:
      tags:
      - Forget
      summary: Get forget request status
      description: Gets the status of a previously submitted forget request.
      operationId: Forget_GetForgetRequest
      parameters:
      - name: requestId
        in: path
        description: The unique identifier of the forget request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource_ForgetRequest'
              example:
                status: 200
                data:
                  requestID: ''
                  status: ''
                  submittedDate: '0001-01-01T00:00:00'
                  processedDate: null
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 400
                error: ERROR_INVALID_PARAMETER
                message: An invalid value was supplied for {Parameter}.
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 404
                error: ERROR_UNABLE_TO_LOCATE_RESOURCE
                message: Unable to locate a resource associated with the requestId supplied.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 401
                error: ERROR_UNAUTHORIZED
                message: Authorization was denied for this request.
      security:
      - OAuth 2: []
      x-code-samples:
      - lang: C#
        source: 'var client = new HttpClient();


          client.BaseAddress = new Uri("https://api.listrak.com/privacy/");

          client.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);


          var response = await client.GetAsync("v1/Forget/{requestId}");

          '
      - lang: PHP
        source: "$client = new \\GuzzleHttp\\Client([\n\t'base_uri' => 'https://api.listrak.com/privacy/'\n]);\n\n$res = $client->request('GET', 'v1/Forget/{requestId}',  [\n\t'headers' => ['Authorization' => 'Bearer ' . $accessToken]\n]);\n"
  /v1/Forget:
    post:
      tags:
      - Forget
      summary: Submit a forget request
      description: Queues a forget request based on unique identifiers such as email address, phone number, etc.
      operationId: Forget_PostForgetRequest
      responses:
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 400
                error: ERROR_INVALID_PARAMETER
                message: An invalid value was supplied for {Parameter}.
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCreated'
              example:
                status: 201
                resourceId: '{ResourceId}'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 401
                error: ERROR_UNAUTHORIZED
                message: Authorization was denied for this request.
      security:
      - OAuth 2: []
      x-code-samples:
      - lang: C#
        source: "var client = new HttpClient();\n\nclient.BaseAddress = new Uri(\"https://api.listrak.com/privacy/\");\nclient.DefaultRequestHeaders.Add(\"Authorization\", \"Bearer \" + token);\n\nvar response = await client.PostAsJsonAsync(\"v1/Forget\", new\n{\n   EmailAddress =   ,\n   PhoneNumber = null\n});\n"
      - lang: PHP
        source: "$client = new \\GuzzleHttp\\Client([\n\t'base_uri' => 'https://api.listrak.com/privacy/'\n]);\n\n$res = $client->request('POST', 'v1/Forget',  [\n\t'headers' => ['Authorization' => 'Bearer ' . $accessToken],\n\t'json' => $jsonBody\n]);\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgetRequestParameters'
        description: The unique identifiers related to the forget request.
        required: true
components:
  schemas:
    ForgetRequestParameters:
      description: A Forget Request Parameters resource.
      type: object
      properties:
        emailAddress:
          description: The email address of the contact to forget.
          type: string
        phoneNumber:
          description: The phone number of the contact to forget.
          type: string
    ForgetRequest:
      description: A Forget Request resource.
      type: object
      properties:
        requestID:
          description: The unique identifier of the forget request.
          type: string
        status:
          description: The status (PROCESSING or COMPLETE) of the forget request.
          type: string
        submittedDate:
          format: date-time
          description: The date the forget request was submitted.
          type: string
        processedDate:
          format: date-time
          description: The date the forget request was processed. This is null if the status is not COMPLETE.
          type: string
    ResourceCreated:
      type: object
      properties:
        status:
          format: int32
          description: HTTP status code.
          type: integer
        resourceId:
          description: An identifier used to locate a resource.
          type: string
    Error:
      type: object
      properties:
        status:
          format: int32
          description: HTTP status code.
          type: integer
        error:
          description: Error code indicating what error has occured.
          type: string
        message:
          description: Message describing the status and the error that occurred.
          type: string
    Resource_ForgetRequest:
      type: object
      properties:
        status:
          format: int32
          description: HTTP status code.
          type: integer
        data:
          $ref: '#/components/schemas/ForgetRequest'
          description: Return data.
x-tagGroups:
- name: API Reference
  tags:
  - Forget