The Template Controller provides comprehensive management of templates across the AdmiralCloud platform. Templates serve as reusable design patterns for various external interfaces and communications, ensuring brand consistency and streamlined workflows.
Key Features
- Versatile Application: Create and manage templates for multiple use cases including press areas, embed links, email communications, players, and more
- Customizable Design: Full control over HTML, CSS, and content elements
- Security Controls: Configure authentication, IP whitelisting, and access permissions
- Player Integration: Customize player appearance and behavior for optimal media presentation
- Notification Triggers: Set up automated workflows with notification system integration
Templates help you maintain consistent branding while simplifying content distribution through standardized layouts and designs.
Reference
Find templates
Retrieve templates based on specified criteria. This endpoint allows you to search for templates by ID or type, making it easy to locate specific templates within your organization’s collection.
Templates can be filtered by their intended use (pressarea, email, player, etc.), enabling you to quickly find the right template for your current needs. Use this endpoint to browse available templates before applying them to your content.
GET/v5/template
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | integer | ✗ | Id of the template |
| type | string | ✗ | Type of the template allowed values: collaborationcollectiondownloadlinkdropsiteemaillivestreamingmediahubmultidownloadpinboardplayerpressarea |
Response
| Field | Type | Description |
|---|---|---|
| creatorId | integer | Id of the creator of this template |
| css | array | CSS instructions for the template |
| customerId | integer | Id of the customer of this template. Customer 1 are managed templates you cannot change |
| data | array | Data for this template |
| defaultTemplate | boolean | TRUE, if template is the defaultTemplate for this type |
| files | array | Files for thos template |
| flag | integer | Flag of the template |
| html | array | HTML instructions for the template |
| id | integer | Id of the template |
| lastEditorId | integer | Id of the last editor of this template |
| name | string | Name of the template |
| securitySettings | object | securitySettings for this template |
| └ auth | object | authentication settings for this template. will be inherited by items based on this template, e.g. publicarea |
| └ enabled | boolean | If true, authentication is activated/required |
| └ extAuth | object | Ext Auth settings |
| └ enabled | boolean | If true, ext auth mechanism is activated |
| └ allowedAccessKeys | array | List of user accessKeys which can use extAuth mechanism |
| └ oauth | object | OAuth settings |
| └ enabled | boolean | If true, oauth mechanism is activated |
| └ clientId | string | ClientId for OAuth mechanism |
| └ ipWhiteList | object | IP whitelist settings |
| └ enabled | boolean | If true, IP whitelisting is activated |
| └ authOnly | boolean | If true, TBC – TO CLARIFY |
| object | settings for this email template | |
| └ clientId | string | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | Restrict usage of this email template to certain memberGroups |
| └ ipWhiteList | cidr | The actual IP whitelist as array of CIDRs |
| └ cidr | cidr | CIDR to whitelist |
| └ type | string | Type of the CIDR allowed values: ipv4ipv6 |
| └ matchReferer | array | Referers (FQDN) which are allowed |
| └ url | object | Custom URL settings |
| └ cname | fqdn | CNAME to use with this template |
| └ prefix | string | Prefix to use for URLs |
| settings | object | settings for the template |
| └ bgColor | string | backgroundColor for player |
| └ customPlayButton | boolean | customPlayButton for player |
| object | settings for this email template | |
| └ clientId | string | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | Restrict usage of this email template to certain memberGroups |
| └ fgColor | string | fgColor for player |
| └ playheadColor | string | playheadColor for player |
| └ playerConfigurationId | object | playerConfigurationId for template |
| └ video | integer | |
| └ audio | integer | |
| └ image | integer | |
| └ document | integer | |
| └ progressColor | string | progressColor for player |
| └ sliderColor | string | sliderColor for player |
| └ transparentControlbar | boolean | If true, controlbar is transparent for player |
| └ trigger | object | Trigger for notification service |
| └ dropsite | object | Trigger settings for dropsites |
| └ mediaContainerId | integer | MediaContainer to "listen" to |
| └ bgColor | string | backgroundColor for player |
| type | string | Type of the template allowed values: collaborationcollectiondownloadlinkdropsiteemaillivestreamingmediahubmultidownloadpinboardplayerpressarea |
Create template
Create a new custom template to enhance your media presentation and user experience. This endpoint enables you to define templates for various purposes such as press areas, players, email communications, and more.
When creating a template, you can specify HTML structure, CSS styling, security settings, and player behavior configurations. Templates provide consistency across your digital assets while allowing for brand-aligned customization.
For email templates, you can set specific access restrictions and targeting options to control template usage within your organization.
POST/v5/template
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| basedOn | integer | ✗ | Id of the template this new template should be based on Deprecated |
| css | array | ✗ | CSS instructions for the template |
| files | array | ✗ | Files for thos template |
| html | array | ✗ | HTML instructions for the template |
| name | string | ✓ | Name of the template |
| securitySettings | object | ✗ | securitySettings for this template |
| └ auth | object | ✗ | authentication settings for this template. will be inherited by items based on this template, e.g. publicarea |
| └ enabled | boolean | ✗ | If true, authentication is activated/required |
| └ extAuth | object | ✗ | Ext Auth settings |
| └ enabled | boolean | ✗ | If true, ext auth mechanism is activated |
| └ allowedAccessKeys | array | ✗ | List of user accessKeys which can use extAuth mechanism |
| └ oauth | object | ✗ | OAuth settings |
| └ enabled | boolean | ✗ | If true, oauth mechanism is activated |
| └ clientId | string | ✗ | ClientId for OAuth mechanism |
| └ ipWhiteList | object | ✗ | IP whitelist settings |
| └ enabled | boolean | ✗ | If true, IP whitelisting is activated |
| └ authOnly | boolean | ✗ | If true, TBC – TO CLARIFY |
| object | ✗ | settings for this email template | |
| └ clientId | string | ✗ | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | ✗ | Restrict usage of this email template to certain memberGroups |
| └ ipWhiteList | cidr | ✗ | The actual IP whitelist as array of CIDRs |
| └ matchReferer | array | ✗ | Referers (FQDN) which are allowed |
| └ url | object | ✗ | Custom URL settings |
| └ cname | fqdn | ✗ | CNAME to use with this template |
| └ prefix | string | ✗ | Prefix to use for URLs |
| settings | object | ✗ | settings for the template |
| └ bgColor | string | ✗ | backgroundColor for player |
| └ customPlayButton | boolean | ✗ | customPlayButton for player |
| object | ✗ | settings for this email template | |
| └ clientId | string | ✗ | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | ✗ | Restrict usage of this email template to certain memberGroups |
| └ fgColor | string | ✗ | fgColor for player |
| └ playheadColor | string | ✗ | playheadColor for player |
| └ playerConfigurationId | object | ✗ | playerConfigurationId for template |
| └ video | integer | ✗ | |
| └ audio | integer | ✗ | |
| └ image | integer | ✗ | |
| └ document | integer | ✗ | |
| └ progressColor | string | ✗ | progressColor for player |
| └ sliderColor | string | ✗ | sliderColor for player |
| └ transparentControlbar | boolean | ✗ | If true, controlbar is transparent for player |
| └ trigger | object | ✗ | Trigger for notification service |
| └ dropsite | object | ✗ | Trigger settings for dropsites |
| └ mediaContainerId | integer | ✗ | MediaContainer to "listen" to |
| └ bgColor | string | ✗ | backgroundColor for player |
| type | string | ✓ | Type of the template allowed values: collaborationcollectiondownloadlinkdropsiteemaillivestreamingmediahubmultidownloadpinboardplayerpressarea |
Response
| Field | Type | Description |
|---|---|---|
| creatorId | integer | Id of the creator of this template |
| css | array | CSS instructions for the template |
| customerId | integer | Id of the customer of this template. Customer 1 are managed templates you cannot change |
| data | array | Data for this template |
| defaultTemplate | boolean | TRUE, if template is the defaultTemplate for this type |
| files | array | Files for thos template |
| flag | integer | Flag of the template |
| html | array | HTML instructions for the template |
| id | integer | Id of the template |
| lastEditorId | integer | Id of the last editor of this template |
| name | string | Name of the template |
| securitySettings | object | securitySettings for this template |
| └ auth | object | authentication settings for this template. will be inherited by items based on this template, e.g. publicarea |
| └ enabled | boolean | If true, authentication is activated/required |
| └ extAuth | object | Ext Auth settings |
| └ enabled | boolean | If true, ext auth mechanism is activated |
| └ allowedAccessKeys | array | List of user accessKeys which can use extAuth mechanism |
| └ oauth | object | OAuth settings |
| └ enabled | boolean | If true, oauth mechanism is activated |
| └ clientId | string | ClientId for OAuth mechanism |
| └ ipWhiteList | object | IP whitelist settings |
| └ enabled | boolean | If true, IP whitelisting is activated |
| └ authOnly | boolean | If true, TBC – TO CLARIFY |
| object | settings for this email template | |
| └ clientId | string | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | Restrict usage of this email template to certain memberGroups |
| └ ipWhiteList | cidr | The actual IP whitelist as array of CIDRs |
| └ cidr | cidr | CIDR to whitelist |
| └ type | string | Type of the CIDR allowed values: ipv4ipv6 |
| └ matchReferer | array | Referers (FQDN) which are allowed |
| └ url | object | Custom URL settings |
| └ cname | fqdn | CNAME to use with this template |
| └ prefix | string | Prefix to use for URLs |
| settings | object | settings for the template |
| └ bgColor | string | backgroundColor for player |
| └ customPlayButton | boolean | customPlayButton for player |
| object | settings for this email template | |
| └ clientId | string | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | Restrict usage of this email template to certain memberGroups |
| └ fgColor | string | fgColor for player |
| └ playheadColor | string | playheadColor for player |
| └ playerConfigurationId | object | playerConfigurationId for template |
| └ video | integer | |
| └ audio | integer | |
| └ image | integer | |
| └ document | integer | |
| └ progressColor | string | progressColor for player |
| └ sliderColor | string | sliderColor for player |
| └ transparentControlbar | boolean | If true, controlbar is transparent for player |
| └ trigger | object | Trigger for notification service |
| └ dropsite | object | Trigger settings for dropsites |
| └ mediaContainerId | integer | MediaContainer to "listen" to |
| └ bgColor | string | backgroundColor for player |
| type | string | Type of the template allowed values: collaborationcollectiondownloadlinkdropsiteemaillivestreamingmediahubmultidownloadpinboardplayerpressarea |
Update a template
Modify an existing template to adapt to changing design requirements or functional needs. This endpoint allows you to update various aspects of a template including HTML structure, CSS styling, security configurations, and player settings.
Updates are applied to the specified template while maintaining all associations with content that uses this template. This ensures that changes propagate consistently across your digital presence without requiring manual updates to individual instances.
You can refine security settings, adjust visual elements, or enhance functionality while preserving the template’s core identity and connections.
PUT/v5/template/:id
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| css | array | ✗ | CSS instructions for the template |
| files | array | ✗ | Files for thos template |
| html | array | ✗ | HTML instructions for the template |
| id | integer | ✓ | Id of the template |
| name | string | ✗ | Name of the template |
| securitySettings | object | ✗ | securitySettings for this template |
| └ auth | object | ✗ | authentication settings for this template. will be inherited by items based on this template, e.g. publicarea |
| └ enabled | boolean | ✗ | If true, authentication is activated/required |
| └ extAuth | object | ✗ | Ext Auth settings |
| └ enabled | boolean | ✗ | If true, ext auth mechanism is activated |
| └ allowedAccessKeys | array | ✗ | List of user accessKeys which can use extAuth mechanism |
| └ oauth | object | ✗ | OAuth settings |
| └ enabled | boolean | ✗ | If true, oauth mechanism is activated |
| └ clientId | string | ✗ | ClientId for OAuth mechanism |
| └ ipWhiteList | object | ✗ | IP whitelist settings |
| └ enabled | boolean | ✗ | If true, IP whitelisting is activated |
| └ authOnly | boolean | ✗ | If true, TBC – TO CLARIFY |
| object | ✗ | settings for this email template | |
| └ clientId | string | ✗ | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | ✗ | Restrict usage of this email template to certain memberGroups |
| └ ipWhiteList | cidr | ✗ | The actual IP whitelist as array of CIDRs |
| └ matchReferer | array | ✗ | Referers (FQDN) which are allowed |
| └ url | object | ✗ | Custom URL settings |
| └ cname | fqdn | ✗ | CNAME to use with this template |
| └ prefix | string | ✗ | Prefix to use for URLs |
| settings | object | ✗ | settings for the template |
| └ bgColor | string | ✗ | backgroundColor for player |
| └ customPlayButton | boolean | ✗ | customPlayButton for player |
| object | ✗ | settings for this email template | |
| └ clientId | string | ✗ | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | ✗ | Restrict usage of this email template to certain memberGroups |
| └ fgColor | string | ✗ | fgColor for player |
| └ playheadColor | string | ✗ | playheadColor for player |
| └ playerConfigurationId | object | ✗ | playerConfigurationId for template |
| └ video | integer | ✗ | |
| └ audio | integer | ✗ | |
| └ image | integer | ✗ | |
| └ document | integer | ✗ | |
| └ progressColor | string | ✗ | progressColor for player |
| └ sliderColor | string | ✗ | sliderColor for player |
| └ transparentControlbar | boolean | ✗ | If true, controlbar is transparent for player |
| └ trigger | object | ✗ | Trigger for notification service |
| └ dropsite | object | ✗ | Trigger settings for dropsites |
| └ mediaContainerId | integer | ✗ | MediaContainer to "listen" to |
| └ bgColor | string | ✗ | backgroundColor for player |
Response
| Field | Type | Description |
|---|---|---|
| creatorId | integer | Id of the creator of this template |
| css | array | CSS instructions for the template |
| customerId | integer | Id of the customer of this template. Customer 1 are managed templates you cannot change |
| data | array | Data for this template |
| defaultTemplate | boolean | TRUE, if template is the defaultTemplate for this type |
| files | array | Files for thos template |
| flag | integer | Flag of the template |
| html | array | HTML instructions for the template |
| id | integer | Id of the template |
| lastEditorId | integer | Id of the last editor of this template |
| name | string | Name of the template |
| securitySettings | object | securitySettings for this template |
| └ auth | object | authentication settings for this template. will be inherited by items based on this template, e.g. publicarea |
| └ enabled | boolean | If true, authentication is activated/required |
| └ extAuth | object | Ext Auth settings |
| └ enabled | boolean | If true, ext auth mechanism is activated |
| └ allowedAccessKeys | array | List of user accessKeys which can use extAuth mechanism |
| └ oauth | object | OAuth settings |
| └ enabled | boolean | If true, oauth mechanism is activated |
| └ clientId | string | ClientId for OAuth mechanism |
| └ ipWhiteList | object | IP whitelist settings |
| └ enabled | boolean | If true, IP whitelisting is activated |
| └ authOnly | boolean | If true, TBC – TO CLARIFY |
| object | settings for this email template | |
| └ clientId | string | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | Restrict usage of this email template to certain memberGroups |
| └ ipWhiteList | cidr | The actual IP whitelist as array of CIDRs |
| └ cidr | cidr | CIDR to whitelist |
| └ type | string | Type of the CIDR allowed values: ipv4ipv6 |
| └ matchReferer | array | Referers (FQDN) which are allowed |
| └ url | object | Custom URL settings |
| └ cname | fqdn | CNAME to use with this template |
| └ prefix | string | Prefix to use for URLs |
| settings | object | settings for the template |
| └ bgColor | string | backgroundColor for player |
| └ customPlayButton | boolean | customPlayButton for player |
| object | settings for this email template | |
| └ clientId | string | Restrict usage of this email template to certain clientId |
| └ restrictToMemberGroups | array | Restrict usage of this email template to certain memberGroups |
| └ fgColor | string | fgColor for player |
| └ playheadColor | string | playheadColor for player |
| └ playerConfigurationId | object | playerConfigurationId for template |
| └ video | integer | |
| └ audio | integer | |
| └ image | integer | |
| └ document | integer | |
| └ progressColor | string | progressColor for player |
| └ sliderColor | string | sliderColor for player |
| └ transparentControlbar | boolean | If true, controlbar is transparent for player |
| └ trigger | object | Trigger for notification service |
| └ dropsite | object | Trigger settings for dropsites |
| └ mediaContainerId | integer | MediaContainer to "listen" to |
| └ bgColor | string | backgroundColor for player |
| type | string | Type of the template allowed values: collaborationcollectiondownloadlinkdropsiteemaillivestreamingmediahubmultidownloadpinboardplayerpressarea |
Destroy template
Remove a template that is no longer needed from your template library. This endpoint permanently deletes the specified template from the system.
When deleting a template that is currently in use, you can optionally specify a replacement template ID to maintain continuity for content that references the template being removed. This ensures a smooth transition without disrupting user experience or breaking existing content links.
Use this endpoint with caution as template deletion cannot be undone once completed.
DELETE/v5/template/:id
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | integer | ✓ | Id of the template |
| move | integer | ✗ | Id of the template every item based on the template to destroy is moved to. |
Response
| Field | Type | Description |
|---|---|---|
| id | integer | Id of the template |