Get User State
Users
User status
Query and update the status of a user
GET
Get User State
Description
Manage the operational status of a user within your channel. You can check whether a contact is in manual or automatic mode and update this setting to control who responds to conversations.Get User Status
Endpoint
Path Parameters
string
required
User’s phone number (without the
+ sign).Response Example
Change User Status
Endpoint
Request Body
number
Time in seconds that the manual state will remain before automatically expiring.
string
required
Identifier of the channel associated with the user.
string
required
User’s phone number (without the
+ sign).string
required
Target state. Allowed values:
"manual" or "auto".Request Example
cURL
Response Example
Common Errors
400- Could not get or update the user’s status.401- Invalid or missing credentials.404- User or channel not found.