API Reference

Create schedule

post
https://user-api.omni.chat/v1/users/schedules

Creates a scheduled action (enable or disable) for a user.
The scheduled date must be in the future (America/Sao_Paulo timezone).
Only one schedule per user is allowed at a time.
Requires admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The action to be executed at the scheduled time.

Allowed:
string
required

The ID of the user the scheduled action will be applied to.

boolean
required

When true and action is disable, moves the user's customer portfolio to the target user or team.

string

ID of the user to whom conversations will be transferred when the action runs.
Mutually exclusive with teamId. Cannot be the same as userId.

string

ID of the team to which conversations will be transferred when the action runs.
Mutually exclusive with toId.

schedule
object
required
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?