Skip to main content
POST
/
agency
/
source
Add a source
curl --request POST \
  --url https://api.closebot.com/agency/source \
  --header 'Content-Type: application/json' \
  --header 'X-CB-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "category": "<string>",
  "key": "<string>",
  "accessToken": "<string>",
  "refreshToken": "<string>",
  "expiresIn": 123,
  "autoShutoff": true,
  "gracefulGoodbye": true,
  "summarizeAttachments": true,
  "webhookCallback": "<string>"
}
'
{
  "agencyId": "<string>",
  "sourceId": "<string>",
  "name": "<string>",
  "category": "<string>",
  "key": "<string>",
  "accessToken": "<string>",
  "address": "<string>",
  "connected": true,
  "autoShutoff": true,
  "gracefulGoodbye": true,
  "bots": [
    {
      "id": "<string>",
      "botName": "<string>",
      "tags": [
        {
          "name": "<string>",
          "approveDeny": true,
          "id": "<string>"
        }
      ],
      "channels": [
        "<string>"
      ],
      "personaNameOverride": "<string>",
      "enabled": true
    }
  ],
  "accountsWithAccess": [
    "<string>"
  ],
  "isAvailabilityContactTimezone": true,
  "respondWindows": [
    {
      "dayOfWeekUtc": "<string>",
      "startTimeUtc": "<string>",
      "duration": "<string>"
    }
  ],
  "doNotRespondWindows": [
    {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    }
  ],
  "summarizeAttachments": true,
  "respondToReactions": true,
  "markConversationAsUnread": true,
  "webhookCallback": "<string>",
  "wallet": {
    "reBilling": true,
    "autoRefill": true,
    "topUpAmount": 123,
    "refillThreshold": 123,
    "stripeCustomerId": "<string>",
    "currency": "<string>",
    "responseUnitCostOverride": "<string>",
    "storageUnitCostOverride": "<string>",
    "userUnitCostOverride": "<string>"
  }
}

Authorizations

X-CB-KEY
string
header
required

CloseBot API Key Authorization

Body

Source information.

name
string | null
category
string | null
key
string | null
accessToken
string | null
refreshToken
string | null
expiresIn
integer<int32> | null
autoShutoff
boolean | null
gracefulGoodbye
boolean | null
summarizeAttachments
boolean | null
webhookCallback
string | null

Response

Success

agencyId
string | null
sourceId
string | null
name
string | null
category
string | null
key
string | null
accessToken
string | null
address
string | null
connected
boolean
autoShutoff
boolean
gracefulGoodbye
boolean
bots
object[] | null
accountsWithAccess
string[] | null
isAvailabilityContactTimezone
boolean
respondWindows
object[] | null
doNotRespondWindows
object[] | null
summarizeAttachments
boolean
respondToReactions
boolean
markConversationAsUnread
boolean
webhookCallback
string | null
wallet
object