API referencePipeline

Create pipeline card

Creates a pipeline card (a draft launch) titled title. Optionally set its starting stage (defaults to REQUESTED), attach creativeIds and assign teammates with assigneeIds.

POST
/v1/brands/{brandId}/pipeline/tickets

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
title*string
Length1 <= length <= 500
stage?string
Value in"REQUESTED""ASSETS_UPLOADED""IN_REVIEW""APPROVED""FAILED"
creativeIds?array<>
assigneeIds?array<>
description?string
Lengthlength <= 2000

Response Body

Create pipeline card

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

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

Configure pipeline column

Updates one of the fixed pipeline columns: rename it with name, hide or show it with isHidden, or bind a structure template with bindTemplate to apply when a card enters the column (null unbinds). Binding replaces any publish action on that column. Requires an org admin; columns cannot be created or deleted.

List campaign snapshot templates

Lists the saved campaign snapshot templates. Results are cursor-paginated.