Pular para o conteúdo

POST /v1/plugins

POST
/v1/plugins
curl --request POST \
--url https://seu-endereco-da-api/v1/plugins \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "url": "example", "isDefault": true, "active": true, "allowDataTransfer": true }'

Permissão que a Chave de acesso precisa: Gerenciar plugins (plugins:manage).

Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
url
required
string
>= 1 characters <= 2048 characters
isDefault
boolean
active
boolean
allowDataTransfer
boolean

Example generated

{
"name": "example",
"url": "example",
"isDefault": true,
"active": true,
"allowDataTransfer": true
}
Media typeapplication/json
object
id
required
string
name
required
string
url
required

Https page loaded in the contact drawer, and the only origin the postMessage bridge talks to

string
isDefault
required

Opens by itself when the operator enters the plugins tab

boolean
active
required
boolean
allowDataTransfer
required

Whether the contact being served is sent to this plugin

boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Example generated

{
"id": "example",
"name": "example",
"url": "example",
"isDefault": true,
"active": true,
"allowDataTransfer": true,
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z"
}

Plugin name already in use