APIs & SDKs

Post

post
https://api.formant.io/v1/admin/schedules

Create a new command schedule. Resource: schedules Authorized roles: administrator

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

Schedule

uuid

ID of the organization to which you want to add this new schedule.

string
required
length ≤ 50

Name of this schedule.

string
required
length ≤ 500

User-friendly description of this command schedule.

string
enum
required

Enter command.

Allowed:
date-time | null
required

Timestamp at which this command should execute. Must be in the future. Format: YYYY-MM-DDTHH:MM:SS

string | null
required

Frequency of this command schedule, as defined at https://crontab.guru

int64
required
0 to 9007199254740991

Enter 0 for this parameter.

string
required

Timezone which corresponds to the timestamp provided in the at parameter, in tz database format.

string
uuid | null
required

You must create a command template before you can schedule this command.

string | null
string | null
required

Value of the command parameter to be sent with this scheduled command.

uuid
required

ID of the device to which to send this command.

string
length ≤ 1000

Internal use only, ignore.

uuid
date-time
date-time
Response

Updated 5 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago