Skip to main content
PATCH
/
integrations
/
{id}
Update integration
curl --request PATCH \
  --url https://xquik.com/api/v1/integrations/{id} \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "name": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "isActive": true,
  "silentPush": true,
  "scopeAllMonitors": true,
  "filters": {},
  "messageTemplate": {}
}
'
Free — does not consume credits
curl -X PATCH https://xquik.com/api/v1/integrations/4 \
  -H "x-api-key: xq_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Bot Name",
    "eventTypes": ["tweet.new", "tweet.quote", "tweet.reply"],
    "isActive": true
  }' | jq

Path parameters

id
string
required
The unique integration ID.

Headers

x-api-key
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.
Content-Type
string
required
Must be application/json.

Body

All fields are optional, but at least 1 must be provided.
name
string
Updated integration name.
eventTypes
string[]
Updated array of event types. Must contain at least 1 valid type: tweet.new, tweet.quote, tweet.reply, tweet.retweet, draw.completed, extraction.completed, extraction.failed.
isActive
boolean
Set to false to pause the integration, or true to resume.
silentPush
boolean
When true, Telegram notifications are sent silently (no sound).
scopeAllMonitors
boolean
When true, the integration receives events from all monitors. When false, use filters to scope to specific monitors.
filters
object
Optional event filters to narrow which events trigger notifications.
messageTemplate
object
Custom message template for notifications.

Response

id
string
Unique integration ID.
type
string
Integration type.
name
string
Updated integration name.
config
object
Integration configuration.
eventTypes
string[]
Updated event types.
messageTemplate
string
Custom message template for notifications. null if not set.
scopeAllMonitors
boolean
Whether the integration receives events from all monitors.
silentPush
boolean
Whether Telegram notifications are sent silently.
filters
object
Event filtering rules. null if not set.
isActive
boolean
Current active status after update.
createdAt
string
ISO 8601 creation timestamp.
updatedAt
string
ISO 8601 timestamp of last update.
{
  "id": "4",
  "type": "telegram",
  "name": "Updated Bot Name",
  "config": { "chatId": "-1001234567890" },
  "eventTypes": ["tweet.new", "tweet.quote", "tweet.reply"],
  "messageTemplate": null,
  "scopeAllMonitors": true,
  "silentPush": false,
  "filters": null,
  "isActive": true,
  "createdAt": "2026-03-01T09:00:00.000Z",
  "updatedAt": "2026-03-15T14:30:00.000Z"
}
Related: Get Integration to verify the updated state, or Test Integration to confirm notifications work after updating.