Lithium

Lithium Admin API

The Admin API from Lithium — 2 operation(s) for admin.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.khoros.com/khoroscaredevdocs/docs/khoros-care-integration-overview
📖
Documentation
https://developer.khoros.com/khorosmarketingdevdocs/docs/developing-and-integrating-with-khoros-marketing
📖
Documentation
https://developer.khoros.com/khoros-flow/docs/overview-of-khoros-flow-apis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lithium/refs/heads/main/openapi/lithium-admin-api-openapi.yml

OpenAPI Specification

lithium-admin-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: agent-states-api-v2 AccountSet Admin API
  version: '1.1'
servers:
- url: https://{instance}.response.lithium.com/api/v2/agentstate
  variables:
    instance:
      default: instance
security:
- {}
tags:
- name: Admin
paths:
  /admin/custom:
    post:
      summary: Register a Custom CRM
      description: Register a custom customer relationship manager
      operationId: register-a-custom-crm
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - instanceUrl
              - authHeaderValue
              properties:
                name:
                  type: string
                  description: '**readOnly**: false **Example:** `Custom CRM`'
                instanceUrl:
                  type: string
                  description: '**readOnly**: false **Example:** `https://test-zendesk.heroku.com/api/v1`'
                authHeaderValue:
                  type: string
                  description: '**readOnly**: false **Example:** `MY_AUTH_HEADER`'
      responses:
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: Coming Soon
      deprecated: false
      security: []
      tags:
      - Admin
  /admin/custom/{crmId}:
    patch:
      summary: Register a Custom CRM
      description: Register a custom customer relationship manager
      operationId: register-a-custom-crm-1
      parameters:
      - name: crmId
        in: path
        description: '**Format:** int64'
        schema:
          type: integer
          format: int32
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - instanceUrl
              - authHeaderValue
              properties:
                name:
                  type: string
                  description: '**readOnly**: false **Example:** `Custom CRM`'
                instanceUrl:
                  type: string
                  description: '**readOnly**: false **Example:** `https://test-zendesk.heroku.com/api/v1`'
                authHeaderValue:
                  type: string
                  description: '**readOnly**: false **Example:** `MY_AUTH_HEADER`'
      responses:
        '400':
          description: '400'
          content:
            text/plain:
              examples:
                Result:
                  value: Coming Soon
      deprecated: false
      security: []
      tags:
      - Admin
x-readme:
  headers: []
  explorer-enabled: false
  proxy-enabled: false
x-readme-fauxas: true