Create Instance

Developing

POST

http://localhost:3000/api/instance/create

Last modified:2025-11-24 08:12:45

Maintainer:rama adhitya setiadi

Create Instance

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'http://localhost:3000/api/instance/create' \
--header 'x-api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "name instance1",
    "phoneNumber": "62895347113987"
}'

Response Example

{
    "success": true,
    "data": {
        "id": "3a4cc1e5-e94f-427f-93a6-7adce5426bdf",
        "name": "name instance",
        "phoneNumber": "628951234567",
        "pairingCode": null,
        "status": "disconnected",
        "qrCode": null,
        "isActive": true,
        "webhookUrl": null,
        "createdAt": "2025-11-08T13:19:25.314Z",
        "updatedAt": "2025-11-08T13:19:25.314Z"
    },
    "message": "Instance created successfully. Use /qr or /pairing-code endpoints to authenticate."
}

Modified at 2025-11-24 08:12:45

Generate QR Instance