Ad Account Requests commands
The 5 koast CLI commands for the Ad Account Requests operations.
Every command is one API operation, named by its operationId. Global flags such as --output and --api-url work on all of them, see CLI commands.
add-ad-account-funds
Add ad account funds. POST /v1/ad-account-requests/{requestId}/top-ups, API reference.
koast add-ad-account-funds --request-id <request-id> --ad-account-id <ad-account-id> --budget-cents <budget-cents> --payment-method <payment-method> [--json <file|->]| Flag | Type | Required | Description |
|---|---|---|---|
--request-id | string | Yes | The ad account request id, or its Koast reference (KST-…). At most 40 characters. |
--ad-account-id | string | Yes | The ad account to fund, act_…: one of the request's accounts. At most 40 characters. |
--budget-cents | integer | Yes | The budget to land on the ad account, in cents of the request's currency. Koast's fee and the platform location fee are added on top of it. |
--payment-method | string | Yes | How the customer pays: card, bank_transfer (a US bank transfer, USD accounts only) or crypto (USDC, USD accounts only, when Koast offers it). Koast's fee depends on it. One of card, bank_transfer, crypto. |
Required scope: write. Accepts --idempotency-key. The CLI sends a key only when you give one. --json <file|-> supplies the whole body. Body flags are applied over it.
Example:
koast add-ad-account-funds --request-id REQUEST_ID --ad-account-id AD_ACCOUNT_ID --budget-cents 1 --payment-method cardget-ad-account-request
Get ad account request. GET /v1/ad-account-requests/{requestId}, API reference.
koast get-ad-account-request --request-id <request-id>| Flag | Type | Required | Description |
|---|---|---|---|
--request-id | string | Yes | The ad account request id, or its Koast reference (KST-…). At most 40 characters. |
Required scope: read.
Example:
koast get-ad-account-request --request-id REQUEST_IDlist-ad-account-requests
List ad account requests. GET /v1/ad-account-requests, API reference.
koast list-ad-account-requests [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--cursor | string | No | Opaque cursor from the previous page's nextCursor. Omit for the first page. |
--limit | integer | No | Page size. Default 50. Minimum 1, maximum 100. |
Required scope: read. Paged. --all follows nextCursor to the end and prints one JSON line per item.
Example:
koast list-ad-account-requestsquote-ad-account-funds
Quote ad account funds. GET /v1/ad-account-requests/{requestId}/top-ups/quote, API reference.
koast quote-ad-account-funds --request-id <request-id> --ad-account-id <ad-account-id> --budget-cents <budget-cents> --payment-method <payment-method>| Flag | Type | Required | Description |
|---|---|---|---|
--request-id | string | Yes | The ad account request id, or its Koast reference (KST-…). At most 40 characters. |
--ad-account-id | string | Yes | The ad account to fund, act_…: one of the request's accounts. At most 40 characters. |
--budget-cents | integer | Yes | The budget to land on the ad account, in cents of the request's currency. Koast's fee and the platform location fee are added on top of it. |
--payment-method | string | Yes | How the customer pays: card, bank_transfer (a US bank transfer, USD accounts only) or crypto (USDC, USD accounts only, when Koast offers it). Koast's fee depends on it. One of card, bank_transfer, crypto. |
Required scope: read.
Example:
koast quote-ad-account-funds --request-id REQUEST_ID --ad-account-id AD_ACCOUNT_ID --budget-cents 1 --payment-method cardrequest-ad-account-replacement
Request ad account replacement. POST /v1/ad-account-requests/{requestId}/accounts/{adAccountId}/replacement, API reference.
koast request-ad-account-replacement --request-id <request-id> --ad-account-id <ad-account-id> [--json <file|->] [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--request-id | string | Yes | The ad account request id, or its Koast reference (KST-…). At most 40 characters. |
--ad-account-id | string | Yes | The ad account that stopped running, act_…: one of the request's accounts. At most 40 characters. |
--reason | string | No | What happened to the ad account, in the user's words, passed on to the ad account partner. At most 500 characters. |
Required scope: write. Accepts --idempotency-key. The CLI sends a key only when you give one. --json <file|-> supplies the whole body. Body flags are applied over it.
Example:
koast request-ad-account-replacement --request-id REQUEST_ID --ad-account-id AD_ACCOUNT_ID