Apply brand config

Config applied and a new version published (or changed: false when it was identical).

POST /v1/brands/{brand_id}/config/apply

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/config/apply' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "document": {},
  "brand_patch": {},
  "connectors": [
    {}
  ],
  "migration": {},
  "expected_config_version": 1,
  "change_note": "string",
  "min_golden_pass_rate": 7.5
}'

200

{
  "brand": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "slug": "acme-outdoors",
    "display_name": "Ada Lovelace",
    "status": "pending",
    "routing_mode": "string",
    "canary_percent": 8,
    "region": "CA",
    "default_locale": "string",
    "policy_set_key": "string",
    "quotas": {},
    "metadata": {},
    "config_version": 1,
    "config_fingerprint": "string",
    "activated_at": "2026-08-31T14:22:05Z",
    "created_at": "2026-08-31T14:22:05Z",
    "updated_at": "2026-08-31T14:22:05Z",
    "workflow_bindings": [
      {
        "workflow_type": null,
        "template_key": null,
        "template_version": null,
        "task_queue": null,
        "enabled": null,
        "deterministic_config": null
      }
    ]
  },
  "connectors": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "connector_key": "string",
      "connector_type": "string",
      "direction": "string",
      "target": {},
      "auth": {
        "secret_ref": null,
        "headers": null
      },
      "retry_policy": {},
      "enabled": true,
      "metadata": {},
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "validation": {
    "valid": true,
    "errors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "checks": [
      {
        "code": null,
        "ok": null,
        "message": null
      }
    ],
    "readiness": {
      "activation_ready": true,
      "self_service_ready": true,
      "summary": "Two-person tent, green — replacement for damaged pole set.",
      "steps": []
    }
  },
  "version": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "version": 1,
    "fingerprint": "sha256:9f86d081884c7d659a2feaa0c55ad015",
    "snapshot": {},
    "published_by": "string",
    "published_at": "2026-08-31T14:22:05Z",
    "is_active": true,
    "created_at": "2026-08-31T14:22:05Z"
  },
  "changed": true
}

Path parameters

brand_id · string (uuid) · required

Request body

object

document · object · required

brand_patch · object

connectors · object[]

migration · object

expected_config_version · integer

change_note · string

min_golden_pass_rate · number

Response

object

brand · object · required

Brand record

Show brand

id · string (uuid) · required

tenant_id · string (uuid) · required

slug · string · required

display_name · string · required

status · string · required

routing_mode · string · required

canary_percent · integer · required

region · string · required

default_locale · string · required

policy_set_key · string

quotas · object · required

metadata · object · required

config_version · integer · required

config_fingerprint · string · required

activated_at · string (date-time)

created_at · string (date-time) · required

updated_at · string (date-time) · required

workflow_bindings · object[] · required

Show workflow_bindings

workflow_type · string · required

template_key · string · required

template_version · integer · required

task_queue · string · required

enabled · boolean · required

deterministic_config · object · required

connectors · object[] · required

Show connectors

id · string (uuid) · required

brand_id · string (uuid) · required

connector_key · string · required

connector_type · string · required

direction · string · required

target · object · required

auth · object · required

Show auth

secret_ref · string

headers · object · required

retry_policy · object · required

enabled · boolean · required

metadata · object · required

created_at · string (date-time) · required

updated_at · string (date-time) · required

validation · object · required

Validation report

Show validation

valid · boolean · required

errors · string[] · required

warnings · string[] · required

checks · object[] · required

Show checks

code · string · required

ok · boolean · required

message · string · required

readiness · object

Show readiness

activation_ready · boolean · required

self_service_ready · boolean · required

summary · string · required

steps · object[] · required

version · object · required

Show version

id · string (uuid) · required

brand_id · string (uuid) · required

version · integer · required

fingerprint · string · required

snapshot · object · required

published_by · string

published_at · string (date-time) · required

is_active · boolean · required

created_at · string (date-time) · required

changed · boolean · required

Status codes

Code	Meaning
200	Config applied and a new version published (or changed: false when it was identical).
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/config/apply' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "document": {},
  "brand_patch": {},
  "connectors": [
    {}
  ],
  "migration": {},
  "expected_config_version": 1,
  "change_note": "string",
  "min_golden_pass_rate": 7.5
}'

200

{
  "brand": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "slug": "acme-outdoors",
    "display_name": "Ada Lovelace",
    "status": "pending",
    "routing_mode": "string",
    "canary_percent": 8,
    "region": "CA",
    "default_locale": "string",
    "policy_set_key": "string",
    "quotas": {},
    "metadata": {},
    "config_version": 1,
    "config_fingerprint": "string",
    "activated_at": "2026-08-31T14:22:05Z",
    "created_at": "2026-08-31T14:22:05Z",
    "updated_at": "2026-08-31T14:22:05Z",
    "workflow_bindings": [
      {
        "workflow_type": null,
        "template_key": null,
        "template_version": null,
        "task_queue": null,
        "enabled": null,
        "deterministic_config": null
      }
    ]
  },
  "connectors": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "connector_key": "string",
      "connector_type": "string",
      "direction": "string",
      "target": {},
      "auth": {
        "secret_ref": null,
        "headers": null
      },
      "retry_policy": {},
      "enabled": true,
      "metadata": {},
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "validation": {
    "valid": true,
    "errors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "checks": [
      {
        "code": null,
        "ok": null,
        "message": null
      }
    ],
    "readiness": {
      "activation_ready": true,
      "self_service_ready": true,
      "summary": "Two-person tent, green — replacement for damaged pole set.",
      "steps": []
    }
  },
  "version": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "version": 1,
    "fingerprint": "sha256:9f86d081884c7d659a2feaa0c55ad015",
    "snapshot": {},
    "published_by": "string",
    "published_at": "2026-08-31T14:22:05Z",
    "is_active": true,
    "created_at": "2026-08-31T14:22:05Z"
  },
  "changed": true
}