Optional
requestFactory: TemplatesApiRequestFactoryOptional
responseProcessor: TemplatesApiResponseProcessorThe event template ID.
The ID of the target app.
Optional
_options: ConfigurationThis will delete the event template. All associated events will be removed from search results and the timeline UI. This action can't be undone, so it's highly recommended that you stop using any associated events before deleting a template. Deletes an event template for the app
The event template ID.
The ID of the target app.
Optional
_options: ConfigurationEvent templates define the general structure for a custom timeline event. This includes formatted copy for its heading and details, as well as any custom property definitions. The event could be something like viewing a video, registering for a webinar, or filling out a survey. A single app can define multiple event templates. Event templates will be created for contacts by default, but they can be created for companies, tickets, and deals as well. Each event template contains its own set of tokens and Markdown
templates. These tokens can be associated with any CRM object properties via the objectPropertyName
field to fully build out CRM objects. You must create an event template before you can create events.
Create an event template for your app
The ID of the target app.
The new event template definition.
Optional
_options: ConfigurationEvent templates define the general structure for a custom timeline event. This includes formatted copy for its heading and details, as well as any custom property definitions. The event could be something like viewing a video, registering for a webinar, or filling out a survey. A single app can define multiple event templates. Event templates will be created for contacts by default, but they can be created for companies, tickets, and deals as well. Each event template contains its own set of tokens and Markdown
templates. These tokens can be associated with any CRM object properties via the objectPropertyName
field to fully build out CRM objects. You must create an event template before you can create events.
Create an event template for your app
The ID of the target app.
The new event template definition.
Optional
_options: ConfigurationUse this to list all event templates owned by your app. List all event templates for your app
The ID of the target app.
Optional
_options: ConfigurationUse this to list all event templates owned by your app. List all event templates for your app
The ID of the target app.
Optional
_options: ConfigurationView the current state of a specific template and its tokens. Gets a specific event template for your app
The event template ID.
The ID of the target app.
Optional
_options: ConfigurationView the current state of a specific template and its tokens. Gets a specific event template for your app
The event template ID.
The ID of the target app.
Optional
_options: ConfigurationUpdates an existing template and its tokens. This is primarily used to update the headerTemplate/detailTemplate, and those changes will take effect for existing events. You can also update or replace all the tokens in the template here instead of doing individual API calls on the /tokens
endpoint.
Update an existing event template
The event template ID.
The ID of the target app.
The updated event template definition.
Optional
_options: ConfigurationUpdates an existing template and its tokens. This is primarily used to update the headerTemplate/detailTemplate, and those changes will take effect for existing events. You can also update or replace all the tokens in the template here instead of doing individual API calls on the /tokens
endpoint.
Update an existing event template
The event template ID.
The ID of the target app.
The updated event template definition.
Optional
_options: Configuration
This will delete the event template. All associated events will be removed from search results and the timeline UI. This action can't be undone, so it's highly recommended that you stop using any associated events before deleting a template. Deletes an event template for the app