Create brand from template file

This endpoint allows API users to upload a template in JSON/XML file with brand settings and current resources.

Get the up-to-date template file here.

Assign the created brand ID to any of these levels:

  • Brand your documents.
  • Brand your document groups.
  • Brand your applications.

The template structure consists of two required objects:

  • title: a string parameter with a brand title.
  • resources: an array of objects with the list of resources and their properties.

Example schema:

{
    "title": "some brand title",
    "resources": [
        "general": {...},
        "editor": {...},
        "send-invite": {...},
        "logo": {...},
        "email-general": {...},
        "email-invite": {...},
        ...
    ]
}

post/v2/brands/upload-file

Request

Headers

multipart/form-data

Request body multipart/form-data

fileunknown required

Response

The brand was created from the file.

Changes

No recorded changes to this operation across all 1 revision of this API.