agents

POST /agents/launch-soon

Schedules an agent to launch before a specific time.

Request

Base URL
https://api.phantombuster.com/api/v2
Auth
API key in header X-Phantombuster-Key
TypeScript
https://skmtc.dev/phantombuster/apis/phantombuster-api-v2/docs/agents/launch-soon/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-Phantombuster-Orgstring

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

Request body

idstring required

Id of the agent to schedule for launch.

minutesinteger required

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.

saveArgumentboolean

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

saveArgumentsboolean

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

Response

Agent has been scheduled to launch successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.