Tenfold Contact Lists API

Contact list management (BETA)

OpenAPI Specification

tenfold-contact-lists-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Tenfold Analytics Contact Lists API
  version: '2.0'
  description: Tenfold (a LivePerson company) is a computer-telephony integration (CTI) platform — the "Customer Experience Cloud" — that connects phone systems and contact-center platforms with CRM and support systems. The REST API lets you originate and query calls, control call recording, manage users and organizations, read and write CRM records, pull call analytics and transcripts, and manage contact lists. This specification was generated by the API Evangelist enrichment pipeline from the public documented endpoint reference at https://apidocs.tenfold.com/ — paths, methods, and summaries are transcribed from the docs; request/response schemas are intentionally generic (the provider does not publish an OpenAPI document).
  contact:
    name: Tenfold Support
    url: https://docs.tenfold.com/
  x-api-evangelist:
    generated: true
    source: https://apidocs.tenfold.com/
servers:
- url: https://api.tenfold.com
  description: Production
- url: https://api-canary.tenfold.com
  description: Beta / canary (subject to change without backward compatibility)
security:
- bearerJWT: []
- oauth2Password: []
tags:
- name: Contact Lists
  description: Contact list management (BETA)
paths:
  /v2/contact-lists:
    get:
      tags:
      - Contact Lists
      operationId: listContactLists
      summary: List the user's contact lists (BETA)
      responses:
        '200':
          description: Contact lists
    post:
      tags:
      - Contact Lists
      operationId: createContactList
      summary: Create a new contact list (BETA)
      responses:
        '201':
          description: List created
  /v2/contact-lists/{listId}:
    get:
      tags:
      - Contact Lists
      operationId: getContactList
      summary: Retrieve a specific contact list (BETA)
      parameters:
      - name: listId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Contact list
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      tags:
      - Contact Lists
      operationId: updateContactList
      summary: Update a contact list (BETA)
      parameters:
      - name: listId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List updated
    delete:
      tags:
      - Contact Lists
      operationId: deleteContactList
      summary: Delete a contact list (BETA)
      parameters:
      - name: listId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: List deleted
  /v2/contact-lists/{listId}/contacts:
    post:
      tags:
      - Contact Lists
      operationId: addContactToList
      summary: Add a contact to a list (BETA)
      parameters:
      - name: listId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Contact added
  /v2/contact-lists/{listId}/contacts/{contactId}:
    delete:
      tags:
      - Contact Lists
      operationId: removeContactFromList
      summary: Remove a contact from a list (BETA)
      parameters:
      - name: listId
        in: path
        required: true
        schema:
          type: string
      - name: contactId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Contact removed
components:
  responses:
    NotFound:
      description: Not Found – The specified path or resource does not exist
  securitySchemes:
    oauth2Password:
      type: oauth2
      description: OAuth 2.0 Resource Owner Password Credentials grant (v1/v2)
      flows:
        password:
          tokenUrl: https://api.tenfold.com/v2/oauth/token
          scopes: {}
    oauth2ClientCredentials:
      type: oauth2
      description: OAuth 2.0 Client Credentials grant
      flows:
        clientCredentials:
          tokenUrl: https://api.tenfold.com/v2/oauth/token
          scopes: {}
    bearerJWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'JWT access token obtained from /v2/users/login, presented as "Authorization: Bearer JWT <token>".'