Skip to main content
PATCH
/
api
/
instances
/
{id}
Update instance settings
curl --request PATCH \
  --url https://api.wappfy.io/api/instances/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "instance_type": "waha",
  "phone_number": "+5511999999999",
  "cloud_phone_number_id": "1234567890",
  "cloud_waba_id": "9876543210",
  "cloud_access_token": "<string>",
  "webhook_url": "https://example.com/webhook"
}
'
{
  "id": "<string>",
  "user_id": "<string>",
  "name": "<string>",
  "instance_type": "waha",
  "status": "created",
  "is_active": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "phone_number": "<string>",
  "display_name": "<string>",
  "session_name": "<string>",
  "phone_number_id": "<string>",
  "waba_id": "<string>",
  "access_token": "<string>",
  "webhook_url": "<string>",
  "profile_picture_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Instance ID

Body

application/json
​
name
string

Optional display name for the instance

​
instance_type
enum<string>
Available options:
waha,
cloud_api
​
phone_number
string

Phone number in international format (e.g., +5511999999999)

Example:

"+5511999999999"

​
cloud_phone_number_id
string

Cloud API Phone Number ID (from Meta Business)

Example:

"1234567890"

​
cloud_waba_id
string

Cloud API WhatsApp Business Account ID

Example:

"9876543210"

​
cloud_access_token
string

Cloud API permanent access token from Meta

​
webhook_url
string

Custom webhook URL for this instance

Example:

"https://example.com/webhook"

Response

Instance updated

​
id
string
required
​
user_id
string
required
​
name
string
required
​
instance_type
enum<string>
required
Available options:
waha,
cloud_api
​
status
enum<string>
required
Available options:
created,
starting,
scan_qr,
connected,
disconnected,
failed
​
is_active
boolean
required
​
created_at
string
required
​
updated_at
string
required
​
phone_number
string
​
display_name
string

WhatsApp display name (pushName)

​
session_name
string
​
phone_number_id
string
​
waba_id
string
​
access_token
string
​
webhook_url
string
​
profile_picture_url
string