- Messages
- Users
- Instances
- Webhook
- Queues
- Groups
- Manage
Create new instance
POST
/instances
Instances
Last modified:2024-06-12 01:04:44
OperationId:InstancesController_create
/instances/{id}/restart
Request
Authorization
Add parameter in header
authorization
Example:
authorization: ********************
Body Params application/json
status
enum<string>
required
Allowed values:
activesuspendedcanceled
name
string
required
deliveryWebhookUrl
string
required
receivedWebhookUrl
string
required
disconnectedWebhookUrl
string
required
connectedWebhookUrl
string
required
instanceId
string
required
Example
{
"status": "active",
"name": "string",
"deliveryWebhookUrl": "string",
"receivedWebhookUrl": "string",
"disconnectedWebhookUrl": "string",
"connectedWebhookUrl": "string",
"instanceId": "string"
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/instances' \
--header 'Content-Type: application/json' \
--header 'authorization;' \
--data-raw '{
"status": "active",
"name": "string",
"deliveryWebhookUrl": "string",
"receivedWebhookUrl": "string",
"disconnectedWebhookUrl": "string",
"connectedWebhookUrl": "string",
"instanceId": "string"
}'
Responses
🟢201Success
application/json
Body
name
string
required
deliveryWebhookUrl
string
required
Example:
https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf
receivedWebhookUrl
string
required
Example:
https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf
disconnectedWebhookUrl
string
required
Example:
https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf
connectedWebhookUrl
string
required
Example:
https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf
instanceId
string
required
Example
{
"name": "string",
"deliveryWebhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf",
"receivedWebhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf",
"disconnectedWebhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf",
"connectedWebhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf",
"instanceId": "string"
}
🟠400400
🔴500500
Modified at 2024-06-12 01:04:44