Generated by API Evangelist
Written by API Evangelist tooling for Canvas's API. It is a proposal applied on top of the contract, not a document Canvas publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Canvas LMS REST Shared Brand Configs API
version: 1.0.0
extends: openapi/canvas-shared-brand-configs-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v1/accounts/{account_id}/shared_brand_configs'].post
update:
x-apievangelist-phrasing:
intent: Share a theme with the account
effect: write
questions:
- How do I save a custom theme so other admins in my account can use it?
- Can I give a brand config a name and share it account-wide?
instructions:
- text: Share theme {brand_config_md5} as {name} in account {account_id}.
slots:
brand_config_md5: requestBody.shared_brand_config[brand_config_md5]
name: requestBody.shared_brand_config[name]
account_id: path.account_id
- text: Publish brand config {brand_config_md5} to account {account_id} under the name {name}.
slots:
brand_config_md5: requestBody.shared_brand_config[brand_config_md5]
account_id: path.account_id
name: requestBody.shared_brand_config[name]
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/shared_brand_configs/{id}'].put
update:
x-apievangelist-phrasing:
intent: Rename or repoint a shared theme
effect: write
questions:
- How do I rename a theme that's already shared?
- Can I point an existing shared theme at a newer brand config?
instructions:
- text: Update shared theme {id} in account {account_id}.
slots:
id: path.id
account_id: path.account_id
- text: Point shared theme {id} in account {account_id} to the latest brand config.
slots:
id: path.id
account_id: path.account_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/shared_brand_configs/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Stop sharing a theme
effect: destructive
questions:
- How do I remove a shared theme so nobody can pick it anymore?
- Can I unshare a theme from my account?
instructions:
- text: Unshare theme {id}.
slots:
id: path.id
- text: Delete shared brand config {id} so it no longer appears as an option.
slots:
id: path.id
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.