Skip to main content

Create Instance

POST 
/api/v2/business/:businessId/instance

Create an instance that will serve as an interface for communicating with WhatsApp.

➡️ Tip: after creating the instance define a [webhook here](#/Instance - Views Controller/WebhookController_createWebhook).

Request​

Path Parameters

    businessId stringrequired

    Business ID.

Body

The instance name is optional, if not informed, a random name will be defined automatically.

    instanceName Instance Name

    Define a name for the instance

    externalId External Id

    Define an instanceId id for your instance

Responses​

InstanceCreateResponse

Schema
    instanceId stringrequired
    name stringrequired
    state stringrequired

    Default value: active | inactive

    connection stringrequired

    Default value: open | close | refused

    createdAt date-timerequired
    deletedAt date-timerequired
    businessBusinessId stringrequired
    Auth object
    authId stringrequired
    jwt stringrequired
    createdAt date-timerequired
    updatedAt date-timerequired
Loading...