541 lines
15 KiB
Markdown
541 lines
15 KiB
Markdown
---
|
|
name: brands-routes
|
|
description: Handle 52 OpenAPI operation(s) under /api/v1/brands for the brands route group.
|
|
---
|
|
|
|
# brands API Routes
|
|
|
|
Handle 52 OpenAPI operation(s) under /api/v1/brands for the brands route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_brands
|
|
|
|
- Operation ID: `list_brands`
|
|
- Route: `GET /api/v1/brands`
|
|
- Mode: READ
|
|
- Summary: List all brands
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `q` in `query`
|
|
|
|
### create_brand
|
|
|
|
- Operation ID: `create_brand`
|
|
- Route: `POST /api/v1/brands`
|
|
- Mode: WRITE
|
|
- Summary: Create a brand
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_brand
|
|
|
|
- Operation ID: `get_brand`
|
|
- Route: `GET /api/v1/brands/{brandId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a brand
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### replace_brand
|
|
|
|
- Operation ID: `replace_brand`
|
|
- Route: `PUT /api/v1/brands/{brandId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a brand
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_brand
|
|
|
|
- Operation ID: `delete_brand`
|
|
- Route: `DELETE /api/v1/brands/{brandId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a brand
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### list_brand_domains
|
|
|
|
- Operation ID: `list_brand_domains`
|
|
- Route: `GET /api/v1/brands/{brandId}/domains`
|
|
- Mode: READ
|
|
- Summary: List all domains associated with a brand
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### get_error_page
|
|
|
|
- Operation ID: `get_error_page`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/error`
|
|
- Mode: READ
|
|
- Summary: Retrieve the error page sub-resources
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### get_customized_error_page
|
|
|
|
- Operation ID: `get_customized_error_page`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/error/customized`
|
|
- Mode: READ
|
|
- Summary: Retrieve the customized error page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### replace_customized_error_page
|
|
|
|
- Operation ID: `replace_customized_error_page`
|
|
- Route: `PUT /api/v1/brands/{brandId}/pages/error/customized`
|
|
- Mode: WRITE
|
|
- Summary: Replace the customized error page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_customized_error_page
|
|
|
|
- Operation ID: `delete_customized_error_page`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/pages/error/customized`
|
|
- Mode: WRITE
|
|
- Summary: Delete the customized error page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### get_default_error_page
|
|
|
|
- Operation ID: `get_default_error_page`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/error/default`
|
|
- Mode: READ
|
|
- Summary: Retrieve the default error page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### get_preview_error_page
|
|
|
|
- Operation ID: `get_preview_error_page`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/error/preview`
|
|
- Mode: READ
|
|
- Summary: Retrieve the preview error page preview
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### replace_preview_error_page
|
|
|
|
- Operation ID: `replace_preview_error_page`
|
|
- Route: `PUT /api/v1/brands/{brandId}/pages/error/preview`
|
|
- Mode: WRITE
|
|
- Summary: Replace the preview error page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_preview_error_page
|
|
|
|
- Operation ID: `delete_preview_error_page`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/pages/error/preview`
|
|
- Mode: WRITE
|
|
- Summary: Delete the preview error page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### get_sign_in_page
|
|
|
|
- Operation ID: `get_sign_in_page`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/sign-in`
|
|
- Mode: READ
|
|
- Summary: Retrieve the sign-in page sub-resources
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### get_customized_sign_in_page
|
|
|
|
- Operation ID: `get_customized_sign_in_page`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/sign-in/customized`
|
|
- Mode: READ
|
|
- Summary: Retrieve the customized sign-in page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### replace_customized_sign_in_page
|
|
|
|
- Operation ID: `replace_customized_sign_in_page`
|
|
- Route: `PUT /api/v1/brands/{brandId}/pages/sign-in/customized`
|
|
- Mode: WRITE
|
|
- Summary: Replace the customized sign-in page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_customized_sign_in_page
|
|
|
|
- Operation ID: `delete_customized_sign_in_page`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/pages/sign-in/customized`
|
|
- Mode: WRITE
|
|
- Summary: Delete the customized sign-in page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### get_default_sign_in_page
|
|
|
|
- Operation ID: `get_default_sign_in_page`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/sign-in/default`
|
|
- Mode: READ
|
|
- Summary: Retrieve the default sign-in page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### get_preview_sign_in_page
|
|
|
|
- Operation ID: `get_preview_sign_in_page`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/sign-in/preview`
|
|
- Mode: READ
|
|
- Summary: Retrieve the preview sign-in page preview
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### replace_preview_sign_in_page
|
|
|
|
- Operation ID: `replace_preview_sign_in_page`
|
|
- Route: `PUT /api/v1/brands/{brandId}/pages/sign-in/preview`
|
|
- Mode: WRITE
|
|
- Summary: Replace the preview sign-in page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_preview_sign_in_page
|
|
|
|
- Operation ID: `delete_preview_sign_in_page`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/pages/sign-in/preview`
|
|
- Mode: WRITE
|
|
- Summary: Delete the preview sign-in page
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### list_all_sign_in_widget_versions
|
|
|
|
- Operation ID: `list_all_sign_in_widget_versions`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/sign-in/widget-versions`
|
|
- Mode: READ
|
|
- Summary: List all Sign-In Widget versions
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### get_sign_out_page_settings
|
|
|
|
- Operation ID: `get_sign_out_page_settings`
|
|
- Route: `GET /api/v1/brands/{brandId}/pages/sign-out/customized`
|
|
- Mode: READ
|
|
- Summary: Retrieve the sign-out page settings
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### replace_sign_out_page_settings
|
|
|
|
- Operation ID: `replace_sign_out_page_settings`
|
|
- Route: `PUT /api/v1/brands/{brandId}/pages/sign-out/customized`
|
|
- Mode: WRITE
|
|
- Summary: Replace the sign-out page settings
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_email_templates
|
|
|
|
- Operation ID: `list_email_templates`
|
|
- Route: `GET /api/v1/brands/{brandId}/templates/email`
|
|
- Mode: READ
|
|
- Summary: List all email templates
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
- `expand` in `query`
|
|
|
|
### get_email_template
|
|
|
|
- Operation ID: `get_email_template`
|
|
- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an email template
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### list_email_customizations
|
|
|
|
- Operation ID: `list_email_customizations`
|
|
- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations`
|
|
- Mode: READ
|
|
- Summary: List all email customizations
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `after` in `query`
|
|
- `limit` in `query`
|
|
|
|
### create_email_customization
|
|
|
|
- Operation ID: `create_email_customization`
|
|
- Route: `POST /api/v1/brands/{brandId}/templates/email/{templateName}/customizations`
|
|
- Mode: WRITE
|
|
- Summary: Create an email customization
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_all_customizations
|
|
|
|
- Operation ID: `delete_all_customizations`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations`
|
|
- Mode: WRITE
|
|
- Summary: Delete all email customizations
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
|
|
### get_email_customization
|
|
|
|
- Operation ID: `get_email_customization`
|
|
- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an email customization
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `customizationId` in `path` required
|
|
|
|
### replace_email_customization
|
|
|
|
- Operation ID: `replace_email_customization`
|
|
- Route: `PUT /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace an email customization
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `customizationId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_email_customization
|
|
|
|
- Operation ID: `delete_email_customization`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an email customization
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `customizationId` in `path` required
|
|
|
|
### get_customization_preview
|
|
|
|
- Operation ID: `get_customization_preview`
|
|
- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview`
|
|
- Mode: READ
|
|
- Summary: Retrieve a preview of an email customization
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `customizationId` in `path` required
|
|
|
|
### get_email_default_content
|
|
|
|
- Operation ID: `get_email_default_content`
|
|
- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/default-content`
|
|
- Mode: READ
|
|
- Summary: Retrieve an email template default content
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `language` in `query`
|
|
|
|
### get_email_default_preview
|
|
|
|
- Operation ID: `get_email_default_preview`
|
|
- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview`
|
|
- Mode: READ
|
|
- Summary: Retrieve a preview of the email template default content
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `language` in `query`
|
|
|
|
### get_email_settings
|
|
|
|
- Operation ID: `get_email_settings`
|
|
- Route: `GET /api/v1/brands/{brandId}/templates/email/{templateName}/settings`
|
|
- Mode: READ
|
|
- Summary: Retrieve the email template settings
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
|
|
### replace_email_settings
|
|
|
|
- Operation ID: `replace_email_settings`
|
|
- Route: `PUT /api/v1/brands/{brandId}/templates/email/{templateName}/settings`
|
|
- Mode: WRITE
|
|
- Summary: Replace the email template settings
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### send_test_email
|
|
|
|
- Operation ID: `send_test_email`
|
|
- Route: `POST /api/v1/brands/{brandId}/templates/email/{templateName}/test`
|
|
- Mode: WRITE
|
|
- Summary: Send a test email
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `templateName` in `path` required
|
|
- `language` in `query`
|
|
|
|
### list_brand_themes
|
|
|
|
- Operation ID: `list_brand_themes`
|
|
- Route: `GET /api/v1/brands/{brandId}/themes`
|
|
- Mode: READ
|
|
- Summary: List all themes
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
|
|
### get_brand_theme
|
|
|
|
- Operation ID: `get_brand_theme`
|
|
- Route: `GET /api/v1/brands/{brandId}/themes/{themeId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a theme
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `themeId` in `path` required
|
|
|
|
### replace_brand_theme
|
|
|
|
- Operation ID: `replace_brand_theme`
|
|
- Route: `PUT /api/v1/brands/{brandId}/themes/{themeId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace a theme
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `themeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### upload_brand_theme_background_image
|
|
|
|
- Operation ID: `upload_brand_theme_background_image`
|
|
- Route: `POST /api/v1/brands/{brandId}/themes/{themeId}/background-image`
|
|
- Mode: WRITE
|
|
- Summary: Upload the background image
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `themeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_brand_theme_background_image
|
|
|
|
- Operation ID: `delete_brand_theme_background_image`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/themes/{themeId}/background-image`
|
|
- Mode: WRITE
|
|
- Summary: Delete the background image
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `themeId` in `path` required
|
|
|
|
### upload_brand_theme_favicon
|
|
|
|
- Operation ID: `upload_brand_theme_favicon`
|
|
- Route: `POST /api/v1/brands/{brandId}/themes/{themeId}/favicon`
|
|
- Mode: WRITE
|
|
- Summary: Upload the favicon
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `themeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_brand_theme_favicon
|
|
|
|
- Operation ID: `delete_brand_theme_favicon`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/themes/{themeId}/favicon`
|
|
- Mode: WRITE
|
|
- Summary: Delete the favicon
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `themeId` in `path` required
|
|
|
|
### upload_brand_theme_logo
|
|
|
|
- Operation ID: `upload_brand_theme_logo`
|
|
- Route: `POST /api/v1/brands/{brandId}/themes/{themeId}/logo`
|
|
- Mode: WRITE
|
|
- Summary: Upload the logo
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `themeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_brand_theme_logo
|
|
|
|
- Operation ID: `delete_brand_theme_logo`
|
|
- Route: `DELETE /api/v1/brands/{brandId}/themes/{themeId}/logo`
|
|
- Mode: WRITE
|
|
- Summary: Delete the logo
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `themeId` in `path` required
|
|
|
|
### get_all_well_known_ur_is
|
|
|
|
- Operation ID: `get_all_well_known_ur_is`
|
|
- Route: `GET /api/v1/brands/{brandId}/well-known-uris`
|
|
- Mode: READ
|
|
- Summary: Retrieve all the well-known URIs
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### get_root_brand_well_known_uri
|
|
|
|
- Operation ID: `get_root_brand_well_known_uri`
|
|
- Route: `GET /api/v1/brands/{brandId}/well-known-uris/{path}`
|
|
- Mode: READ
|
|
- Summary: Retrieve the well-known URI of a specific brand
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `path` in `path` required
|
|
- `expand` in `query`
|
|
|
|
### get_brand_well_known_uri
|
|
|
|
- Operation ID: `get_brand_well_known_uri`
|
|
- Route: `GET /api/v1/brands/{brandId}/well-known-uris/{path}/customized`
|
|
- Mode: READ
|
|
- Summary: Retrieve the customized content of the specified well-known URI
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `path` in `path` required
|
|
|
|
### replace_brand_well_known_uri
|
|
|
|
- Operation ID: `replace_brand_well_known_uri`
|
|
- Route: `PUT /api/v1/brands/{brandId}/well-known-uris/{path}/customized`
|
|
- Mode: WRITE
|
|
- Summary: Replace the customized well-known URI of the specific path
|
|
- Parameters:
|
|
- `brandId` in `path` required
|
|
- `path` in `path` required
|
|
- Body: JSON request body accepted.
|