WUAPI
  1. Instances
WUAPI
  • Messages
    • Send plain text
      POST
    • Send image
      POST
    • Send audio
      POST
    • Send video
      POST
    • Send document
      POST
    • Send location
      POST
    • Send link
      POST
    • Send contact
      POST
    • Delete message by id
      DELETE
    • Get message by id
      GET
  • Users
    • Create new user
      POST
    • Get all users
      GET
  • Instances
    • Create new instance
      POST
    • List All instance
      GET
    • Update instance
      PUT
    • List by instance id
      GET
    • Delete instance
      DELETE
    • Restart instance
      GET
    • Get QRCode
      GET
    • Get QRCode in base64 image.
      GET
    • Disconnect instance
      GET
    • Update profile picture
      PUT
    • Delete profile picture
      DELETE
    • Update profile name
      PUT
  • Webhook
    • Connection event for your instance
      POST
    • Disconnection event for your instance
      POST
    • Event when you receive a message
      POST
    • Event when you send a message
      POST
  • Queues
    • Get queue instance
    • Delete queue instance
    • Get queue failed instance
    • Retry queue
  • Groups
    • Create new group
    • Get all groups
    • Get group by id
    • Add contact to group
    • Update picture of group
    • Set admins only
    • Add and remove admins in group
  • Manage
    • Restart server
  1. Instances

Create new instance

POST
/instances
Instances
Last modified:2024-06-12 01:04:44
OperationId:InstancesController_create
Whenever an instance was created it must be started with the restart endpoint /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
Instance ID that will be used in all calls used to interact with WhatsApp
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
Previous
Get all users
Next
List All instance
Built with