Update integration metadata

PATCH /integrations/{id}

Authentication

Send your organization API key as a Bearer credential.

Authorization: Bearer YOUR_API_KEY

Path parameters

id number required

Positive integration ID

Example: 42

Body

application/json

name string

String length: maximum 255

Example: Priority leads

event string

Allowed values: reply_received, lead_interested, other_folder

Example: lead_interested

include_thread_link boolean

Example: false

Response

application/json

Integration updated

id number required

Range: x ≥ 1

Example: 42

name string required

Example: Sales Telegram

provider string required

Allowed values: webhook, telegram, max, bitrix

Example: telegram

event string required

Allowed values: reply_received, lead_interested, other_folder

Example: lead_interested

include_thread_link boolean required

Example: false

destination any required

Request

curl --request PATCH \
  --url https://developer.coldy.ai/api/v1/integrations/{id} \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Priority leads",
  "event": "lead_interested",
  "include_thread_link": false
}'

{
  "id": 42,
  "name": "Priority leads",
  "provider": "telegram",
  "event": "lead_interested",
  "include_thread_link": false,
  "destination": {
    "type": "chat_id",
    "chat_id": "-1001234567890"
  }
}

{
  "message": [
    "You put invalid API key. Verify your key with the key from your account in Coldy. Check documenation for info"
  ],
  "statusCode": 400,
  "error": "Invalid API key"
}