Skip to main content
PUT
/
chats
/
{chatId}
/
ephemeral
Set disappearing messages timer
curl --request PUT \
  --url https://wsapi.chat/chats/{chatId}/ephemeral \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "expiration": "off"
}
'
{
  "status": 400,
  "detail": "invalid request body"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Path Parameters

​
chatId
string
required

Chat JID (user or group)

Body

application/json
​
expiration
enum<string>
required

Disappearing messages timer

Available options:
off,
24h,
7d,
90d

Response

Timer set