group.*

Available functions

group.list

List all groups under your account.

Parameters

Name Type Description
token string Your API token

Response data

Result data contains an array/collection of group data structure.

group.get

Get one group's information

Parameters

Name Type Description
token string Your API token
id integer Group ID

Response data

You'll get the group data structure.

Example response

{"data":{"id":1,"name":"example"},"info":[],"status":"success","code":0}

group.lookup

Search groups by exact name.

Parameters

Name Type Description
token string Your API token
name string Group name

Response data

You'll get an array of group data structures.

Example response

{"data":[{"id":1,"name":"example"}],"info":[],"status":"success","code":0}

group.add

Add a new group

Parameters

Name Type Description
token string Your API token
name string Name
autoDelete integer Automatically delete stopped (one-time) cronjobs. 0 for never; 1, 3, 7, 15, 30 for days.
contacts array|integer One or an array of contact ID.

Response data

You'll get the data structure of newly created group.

Example response

{"data":{"id":2,"name":"example"},"info":[],"status":"success","code":0}

group.edit

Update an existing group

Parameters

Name Type Description
token string Your API token
id integer Group ID
name string Name
autoDelete integer Automatically delete stopped (one-time) cronjobs. 0 for never; 1, 3, 7, 15, 30 for days.
contacts array|integer One or an array of contact ID.

Response data

You'll get the structure of updated group.

group.delete

Delete a group

Parameters

Name Type Description
token string Your API token
id integer Group ID

Response data

You'll get the structure of deleted group, with ID set to null.

group.vanish

Delete a group and all cronjobs under that group.

Parameters

Name Type Description
token string Your API token
id integer Group ID

Response data

You'll get the structure of deleted group, with ID set to null.

group.empty

Keep the group and delete all cronjobs under that group.

Parameters

Name Type Description
token string Your API token
id integer Group ID

Response data

You'll get the structure of the group.

group.items

List all cronjobs under a group.

Parameters

Name Type Description
token string Your API token
id integer Group ID

Response data

Result data contains an array/collection of cronjob data structure.