/agents/launch-soon

post

https://api.phantombuster.com/api/v2/agents/launch-soon

Schedules an agent to launch before a specific time.

Body Params

string

required

Id of the agent to schedule for launch.

argument

Agent argument. Can either be a JSON string or a plain object. The argument can be retrieved with buster.argument in the agent’s script.

arguments

Agent argument. Can either be a JSON string or a plain object. The argument can be retrieved with buster.argument in the agent’s script.

minutes

integer

required

≥ 0

Determines in how many minutes the agent will launch. If the agent is launched manually before the expected launch time, the agent will not launch automatically.

saveArgument

boolean

If true, argument will be saved as the default launch options for the agent.

saveArguments

boolean

If true, argument will be saved as the default launch options for the agent.

Headers

X-Phantombuster-Org

string

ID of the org that is perfoming the operation (not necessary when using a third party key)

Responses

200

Agent has been scheduled to launch successfully.

400

A provided parameter is duplicated or the launch argument is too big.