Update template brand settings

Set the workspace fallback brand values email templates render with when no Brand kit supplies them: brandName, logoUrl (https), primaryColor (#RRGGBB), footerText and postalAddress. Send null to clear a value. Only the fields sent change.

Outcome

Before you start

Verify identity and pin the intended organization and environment before discovering the action.
Discover a granted Nurture workspace. The application permission is workspace:write; required workspace access is read_write. A permission alone does not supply a workspace grant.
Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.
Obtain authorization for the documented effect or personal-data export before supplying CLI --confirm or MCP confirm:true.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.template_brand.update --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json

Request

PATCH /api/template-brand

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Field	Required	Type	Constraints
`brandName`	Optional	See schema	{}
`logoUrl`	Optional	See schema	{}
`primaryColor`	Optional	See schema	{}
`footerText`	Optional	See schema	{}
`postalAddress`	Optional	See schema	{}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "brandName": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "logoUrl": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000,
          "pattern": "^https:\\/\\/[^\\s\"'<>]+$"
        },
        {
          "type": "null"
        }
      ]
    },
    "primaryColor": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^#[0-9a-fA-F]{6}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "footerText": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000
        },
        {
          "type": "null"
        }
      ]
    },
    "postalAddress": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "additionalProperties": false
}

Effects

Updates the named template brand settings for the workspace; every later render uses them.

Interpret the response

This is a workspace configuration or policy response, not an independently identified resource. Inspect its values and verify changes with the corresponding read action.

Call app_topolo_nurture.template_brand.get and confirm the changed fields.

Exact success schema:

{
  "type": "object",
  "required": [
    "settings",
    "brand"
  ],
  "properties": {
    "settings": {
      "type": "object",
      "properties": {
        "brandName": {
          "type": [
            "string",
            "null"
          ]
        },
        "logoUrl": {
          "type": [
            "string",
            "null"
          ]
        },
        "primaryColor": {
          "type": [
            "string",
            "null"
          ]
        },
        "footerText": {
          "type": [
            "string",
            "null"
          ]
        },
        "postalAddress": {
          "type": [
            "string",
            "null"
          ]
        },
        "updatedAt": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "brand": {
      "type": "object",
      "required": [
        "sources"
      ],
      "properties": {
        "brandName": {
          "type": [
            "string",
            "null"
          ]
        },
        "logoUrl": {
          "type": [
            "string",
            "null"
          ]
        },
        "primaryColor": {
          "type": [
            "string",
            "null"
          ]
        },
        "footerText": {
          "type": [
            "string",
            "null"
          ]
        },
        "postalAddress": {
          "type": [
            "string",
            "null"
          ]
        },
        "sources": {
          "type": "object"
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "brandName": "Acme",
  "logoUrl": "https://cdn.test/l.png",
  "primaryColor": "#1d4ed8",
  "footerText": "",
  "postalAddress": "1 Road"
}

CLI:

topolo actions validate app_topolo_nurture.template_brand.update --data @payload.json --json
topolo actions plan app_topolo_nurture.template_brand.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.template_brand.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.template_brand.update",
    "input": {
      "brandName": "Acme",
      "logoUrl": "https://cdn.test/l.png",
      "primaryColor": "#1d4ed8",
      "footerText": "",
      "postalAddress": "1 Road"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "settings": {
    "brandName": "Acme",
    "logoUrl": "https://cdn.test/l.png",
    "primaryColor": "#1d4ed8",
    "footerText": null,
    "postalAddress": "1 Road",
    "updatedAt": "2026-10-04T00:32:39.057Z"
  },
  "brand": {
    "sources": {
      "brandName": "settings",
      "logoUrl": "settings",
      "primaryColor": "settings",
      "footerText": "default",
      "postalAddress": "settings",
      "logoAlt": "default",
      "darkPrimaryColor": "default",
      "legalEntityName": "default",
      "unsubscribeText": "default"
    },
    "brandName": "Acme",
    "logoUrl": "https://cdn.test/l.png",
    "primaryColor": "#1d4ed8",
    "footerText": null,
    "postalAddress": "1 Road",
    "logoAlt": null,
    "darkPrimaryColor": null,
    "legalEntityName": null,
    "unsubscribeText": null
  }
}

HTTP 200. Call app_topolo_nurture.template_brand.get and confirm the changed fields.

Another supported request

Input · payload.json:

{
  "brandName": null
}

CLI:

topolo actions validate app_topolo_nurture.template_brand.update --data @payload.json --json
topolo actions plan app_topolo_nurture.template_brand.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.template_brand.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_nurture.template_brand.update",
    "input": {
      "brandName": null
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "settings": {
    "brandName": null,
    "logoUrl": "https://cdn.test/l.png",
    "primaryColor": "#1d4ed8",
    "footerText": null,
    "postalAddress": "1 Road",
    "updatedAt": "2026-10-04T00:32:39.058Z"
  },
  "brand": {
    "sources": {
      "brandName": "default",
      "logoUrl": "settings",
      "primaryColor": "settings",
      "footerText": "default",
      "postalAddress": "settings",
      "logoAlt": "default",
      "darkPrimaryColor": "default",
      "legalEntityName": "default",
      "unsubscribeText": "default"
    },
    "brandName": null,
    "logoUrl": "https://cdn.test/l.png",
    "primaryColor": "#1d4ed8",
    "footerText": null,
    "postalAddress": "1 Road",
    "logoAlt": null,
    "darkPrimaryColor": null,
    "legalEntityName": null,
    "unsubscribeText": null
  }
}

HTTP 200. Call app_topolo_nurture.template_brand.get and confirm the changed fields.

Refused request · permission_denied

Input · payload.json:

{
  "brandName": "x"
}

CLI:

topolo actions validate app_topolo_nurture.template_brand.update --data @payload.json --json
topolo actions plan app_topolo_nurture.template_brand.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 403:

{
  "error": {
    "code": "permission_denied",
    "message": "The credential lacks workspace:write."
  }
}

HTTP 403. Preserve the refusal details and do not claim success.

Refused request · invalid_input

Input · payload.json:

{
  "logoUrl": "http://insecure.test/l.png"
}

CLI:

topolo actions validate app_topolo_nurture.template_brand.update --data @payload.json --json
topolo actions plan app_topolo_nurture.template_brand.update --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 422:

{
  "error": {
    "code": "invalid_input",
    "message": "The input does not match the action schema.",
    "details": [
      {
        "origin": "string",
        "code": "invalid_format",
        "format": "regex",
        "pattern": "/^https:\\/\\/[^\\s\"'<>]+$/",
        "path": [
          "logoUrl"
        ],
        "message": "Invalid string: must match pattern /^https:\\/\\/[^\\s\"'<>]+$/"
      }
    ]
  }
}

HTTP 422. Preserve the refusal details and do not claim success.

Verify the result

Call app_topolo_nurture.template_brand.get and confirm the changed fields.

Errors and recovery

organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

Read the settings first, then send the previous values back.

Preview email template: Render a saved template version (templateId, version?) or an unsaved draft to email-safe HTML (tables, inline styles, dark-mode and mobile rules) plus the auto-generated plain-text alternative, for an optional sample contact. Brand name, email logo, light and dark accent colours, footer, legal entity, postal address and unsubscribe wording come from the workspace TopoloBrand kit when one is bound and readable, else the workspace template brand settings, else neutral defaults; Brand being unavailable never fails a preview. Unsubscribe and preference links are inert placeholders (#unsubscribe, #preferences); a real send substitutes signed recipient links. No side effects: nothing is saved or sent.
Update template brand settings: Set the workspace fallback brand values email templates render with when no Brand kit supplies them: brandName, logoUrl (https), primaryColor (#RRGGBB), footerText and postalAddress. Send null to clear a value. Only the fields sent change.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.

Update template brand settings

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · permission_denied

Refused request · invalid_input

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence