Documentation

Create instance

This request allows you to update an existing WaAPI instance with new configuration settings. Use this method to modify parameters such as instance name, hookUrl, or any other settings as needed.

Request

This section provides an example HTTP request for updating an instance. Make sure to specify the correct URL along with the instance ID, and include any fields in the request body that you wish to update.

Headers

When making this request, it`s important to include Authorization HTTP header

Body

Here, you’ll find an example JSON request data and a detailed table that describes each field.

{
    "name": "My instance",
    "hookUrl": "https://my.site.xyz/waapi",
    "messageHook": true,
    "messageBotHook": true,
    "instanceHook": false
}

Response

Here, you’ll find an example JSON response confirming the successful update, along with a detailed table describing each field. The response contains information about the updated instance, such as the modified settings or status. Refer to the table for the meaning and format of each field.

{
    "id": "c3996092-b982-4af7-8cf1-0cfafea5143c",
    "name": "Darth Maul bot",
    "phone": null,
    "platform": "unknown",
    "status": "created",
    "hookUrl": null,
    "messageHook": false,
    "messageBotHook": false,
    "instanceHook": false
}