RArainbrand
Brands

Create a Brand Edit

Prepare proposed changes without changing the active brand. Inspect progress and the proposal with Get a Brand Edit.

post/brands/{id}/edits

Request

  • Base URL
    https://www.rainbrand.com/api/v1
  • URL
    https://www.rainbrand.com/api/v1/brands/{id}/edits
  • Auth
    • API key in header x-api-key
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://www.rainbrand.com/api/auth/oauth2/authorize
      Token URL: https://www.rainbrand.com/api/auth/oauth2/token

Path parameters

idstring uuid required

Brand ID

Example:e6220a5e-4a68-4d39-8bb9-5105e9a3a164

Headers

idempotency-keystring required

A unique key for this operation. Reuse it when retrying the same request.

Example:acme-atlas-pro-color-update

Request body

baseSkillIdstring uuid required

The active Brand Skill version on which this edit is based.

replacesEditIdstring uuid

A candidate awaiting approval to replace atomically once the new candidate is ready. The previous candidate remains available while preparation is incomplete or unsuccessful.

Example request

{
  "baseSkillId": "6590fb89-c177-45b3-85d4-74ab6b92dc2a",
  "change": {
    "kind": "instruction",
    "instruction": "Update Acme Inc. to use burgundy #6D1A36 for Atlas Pro materials. Keep the rest of the brand unchanged."
  }
}

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.