API referenceAutomations

Save automation

Creates a monitoring automation from the spec in automation, or updates an existing one when automationId is given. On create the spec must be complete (name, actionLevel, actions, frequency, apiOutageAction, rules); on update only the fields you pass are changed.

POST
/v1/brands/{brandId}/automations
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.

brandId*integer

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

Idempotency-Key?string

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

Lengthlength <= 255
application/json
  1. body
automationId?string
Match^[1-9]\d*$
Length1 <= length
automation*

Whole monitoring automation spec: { name, actionLevel, actions[], frequency, apiOutageAction, rules[], campaignIds?, status?, applyToNewCampaigns? }

Response Body

Save automation

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

Required scope: write. CLI: koast save-automation, see Automations commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.