Validate brand

Validation report for the brand’s current configuration.

POST /v1/brands/{brand_id}/validate

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/validate' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "valid": true,
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "checks": [
    {
      "code": "string",
      "ok": true,
      "message": "Two-person tent, green — replacement for damaged pole set."
    }
  ],
  "readiness": {
    "activation_ready": true,
    "self_service_ready": true,
    "summary": "Two-person tent, green — replacement for damaged pole set.",
    "steps": [
      {
        "id": null,
        "title": null,
        "status": null,
        "required": null,
        "summary": null,
        "details": null,
        "action_label": null,
        "suggested_tab": null
      }
    ]
  }
}

Path parameters

brand_id · string (uuid) · required

Request body

JSON body of type GenericObject.

Response

object

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

Show steps

id · string · required

title · string · required

status · string · required

required · boolean · required

summary · string · required

details · string[] · required

action_label · string

suggested_tab · string

Status codes

Code	Meaning
200	Validation report for the brand’s current configuration.
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}/validate' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "valid": true,
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "checks": [
    {
      "code": "string",
      "ok": true,
      "message": "Two-person tent, green — replacement for damaged pole set."
    }
  ],
  "readiness": {
    "activation_ready": true,
    "self_service_ready": true,
    "summary": "Two-person tent, green — replacement for damaged pole set.",
    "steps": [
      {
        "id": null,
        "title": null,
        "status": null,
        "required": null,
        "summary": null,
        "details": null,
        "action_label": null,
        "suggested_tab": null
      }
    ]
  }
}