Edit Instance

Developing

PUT

http://localhost:3000/api/instance/{instanceID}

Last modified:2025-11-08 13:48:45

Maintainer:rama adhitya setiadi

Edit Instance

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://localhost:3000/api/instance/' \
--header 'x-api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "name instance",
    "webhook": ""
}'

Response Example

{
    "success": true,
    "data": {
        "id": "746ba78c-a8c2-49f6-ba9e-361ddd90b8cd",
        "name": "name instance",
        "phoneNumber": "62895347113987:41",
        "pairingCode": null,
        "status": "connected",
        "qrCode": null,
        "isActive": true,
        "webhookUrl": null,
        "createdAt": "2025-11-08T11:56:55.987Z",
        "updatedAt": "2025-11-08T13:34:24.711Z"
    },
    "message": "Instance updated successfully"
}

Modified at 2025-11-08 13:48:45

Info Instance

Delete Instance