API referencePipeline

Move pipeline card

Moves the pipeline card campaignLaunchId to stage: REQUESTED, ASSETS_UPLOADED, IN_REVIEW, APPROVED or FAILED. PUBLISHED cannot be set; a card reaches it only by publishing.

POST
/v1/brands/{brandId}/pipeline/cards/move

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

Header Parameters

Idempotency-Key?string

Retrying with the same key within 24 hours returns the first response without acting again.

Lengthlength <= 255

Request Body

application/json
  1. body
campaignLaunchId?string

The pipeline card (batch) id to move.

Length1 <= length
stage*string
Value in"REQUESTED""ASSETS_UPLOADED""IN_REVIEW""APPROVED""FAILED"

Response Body

Move pipeline card

application/json
  1. response
[key: string]?unknown
curl -X POST "https://example.com/v1/brands/0/pipeline/cards/move" \  -H "Authorization: Bearer koast_sk_..." \  -H "Content-Type: application/json" \  -d '{    "stage": "REQUESTED"  }'
{  "property1": null,  "property2": null}

Required scope: write. CLI: koast move-pipeline-card, see Pipeline commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.

Validate launch

Checks whether the launch can be published. Returns valid plus, per campaign, the missing required assets and the structural errors on each campaign, ad set and ad, each with an inputId and message. Changes nothing.

List pipeline columns

Lists the organization's fixed pipeline columns with their ids, names, stage keys, positions, hidden flag and bound settings.