POST
/v1/agents/{agentKey}/runs/{runId}/launch

Approve a run's pieces together, the way the app's launch does. start picks when they go out:

  • suggested (default): each at its suggested time.
  • now: starting now, with the spacing between them kept.
  • all_now: all of them now.
  • launch: the article at its time, with its launch posts.
  • launch_now: the article and its launch posts now, the rest after.

This counts the same as approving in the app. With no entries, it launches every piece of the run that's waiting for approval and not on hold.

Authorization

apiKey
headerAuthorizationBearer <token>

API key for authenticating protected endpoints. Pass as Bearer token in Authorization header.

Path Parameters

agentKey*string

Which agent, such as changelog

runId*string

The run to launch

Request Body

Body

application/json
  1. body
start?string
Value in"suggested""now""all_now""launch""launch_now"
timeZone?string

IANA time zone that launch_now keeps follow-up times of day in. Defaults to UTC

Length1 <= length <= 64
entries?array<>

The run's entries to launch, from GET /v1/schedule

Items1 <= items <= 100

Response Body

200

application/json
  1. response
approved*array<string>

Entry ids now scheduled

failed*array<>
entries*array<>

The run's entries as they now stand

curl -X POST "https://example.com/v1/agents/string/runs/string/launch" \  -H "Content-Type: application/json" \  -d '{}'
{  "approved": [    "string"  ],  "failed": [    {      "id": "string",      "reason": "string"    }  ],  "entries": [    {      "id": "string",      "contentId": "string",      "kind": "post",      "channel": "string",      "status": "unplanned",      "needsApproval": true,      "publishAt": "string",      "publishedAt": "string",      "failureReason": "string",      "holdReason": "string",      "accountId": "string",      "accountLabel": "string",      "entryRevision": 0    }  ]}