You are here:
API Names for Trails, Modules, and Units
Each content collection, release, trail, module, and unit on your enablement site has its own API name, which is a globally unique ID that references a content path in URLs.
Required Editions
| Available in: Enterprise, Performance, and Unlimited Editions |
| User Roles | |
|---|---|
| This topic supports these enablement site roles: |
|
URL Examples
For example, let’s say that you’ve published content with these API names:
| Content | API Name |
|---|---|
| Unit | learn-the-pure-aloe-sales-pitch |
| Module | pure-aloe-sales-strategies |
| Trail | sell-well-at-pure-aloe |
| Release | q3-learning-updates |
| Content Collection | sales-team-onboarding |
All of these components, except for a release, are included in URLs.
- URL for a trail
- Includes the content collection and trail API names, such
as:
https://purealoe.my.trailhead.com/en/content/sales-team-onboarding/trails/sell-well-at-pure-aloe - URL for a standalone module
- Includes the content collection and module API names, such
as:
https://purealoe.my.trailhead.com/en/content/sales-team-onboarding/modules/pure-aloe-sales-strategies - URL for a module that’s included in a trail
- Includes the content collection, trail, and module API names, such
as:
https://purealoe.my.trailhead.com/en/content/sales-team-onboarding/modules/pure-aloe-sales-strategies?trail_id=sell-well-at-pure-aloe - URL for a unit in a standalone module
- Includes the content collection, module, and unit API names, such
as:
https://purealoe.my.trailhead.com/en/content/sales-team-onboarding/modules/pure-aloe-sales-strategies/learn-the-pure-aloe-sales-pitch - URL for a unit in a module that’s included in a trail
- Includes the content collection, trail, module, and unit API names, such
as:
https://purealoe.my.trailhead.com/en/content/sales-team-onboarding/modules/pure-aloe-sales-strategies/learn-the-pure-aloe-sales-pitch?trail_id=sell-well-at-pure-aloe
Guidelines for Custom API Names
When you enter a title for your content, Trailmaker Content generates an API name based on the title. Optionally, you can specify a custom API name instead of the generated value. Follow these conventions.
- To help you find and manage content in your version control system more easily, specify an API name that’s consistent with the content’s title.
- Keep API names specific but brief.
- Specify API names for content collections that are unique within your Salesforce org.
- Specify API names for releases, trails, modules, and units that are globally unique. In other words, the API names for these records must be unique among all your content collections and all Salesforce orgs. For example, you can’t reuse an API name that another company already used for a published module. And you can’t reuse an API name that your own company already used for a published module in another collection.
- For a release, an API name must contain at least 4 characters and no more than 32 characters.
- For content, an API name must contain at least 4 characters and no more than 80 characters.
- You can’t use spaces in an API name, but you can use hyphens or underscores.
Changes to API Names
In general, don’t change the API name for any content collection, trail, module, or unit after it’s published. Otherwise, you can publish duplicate content and break links that learners have used, shared, or bookmarked.
There’s one exception to this rule. If you migrate published content to a different content collection, specify a new API name for the content when you add it to a new content collection. Trailmaker prevents you from adding content that reuses an API name to a release.
