;
};
## OpenAPI
````yaml specs/legacy/v3/crm-timeline-v3.json PUT /integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}
openapi: 3.0.1
info:
title: Timeline
description: Basepom for all HubSpot Projects
version: v3
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
x-hubspot-api-use-case: >-
After setting up a new set of sign-up flows on your website, update contact
timelines to indicate which flow they completed. In each event, you could
also include a link to open an iframe that displays additional external data
about the event.
x-hubspot-related-documentation:
- name: Timeline Events Guide
url: https://developers.hubspot.com/docs/guides/api/crm/extensions/timeline
x-hubspot-introduction: >-
Use the timeline events API to add custom event information to CRM record
timelines. You'll first need to create a public app, then an event template
to display event data.
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
- name: Batch
paths:
/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}:
put:
tags:
- Basic
summary: Update an event template
description: Update an existing event template, specified by ID.
operationId: >-
put-/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}_update
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
explode: false
schema:
type: integer
format: int32
- name: eventTemplateId
in: path
description: ''
required: true
style: simple
explode: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TimelineEventTemplateUpdateRequest'
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TimelineEventTemplate'
default:
$ref: '#/components/responses/Error'
description: ''
deprecated: true
security:
- oauth2:
- developers-write
components:
schemas:
TimelineEventTemplateUpdateRequest:
required:
- id
- name
- tokens
type: object
properties:
detailTemplate:
type: string
description: >-
This uses Markdown syntax with Handlebars and event-specific data to
render HTML on a timeline when you expand the details.
headerTemplate:
type: string
description: >-
This uses Markdown syntax with Handlebars and event-specific data to
render HTML on a timeline as a header.
id:
type: string
description: The template ID.
name:
type: string
description: The template name.
tokens:
type: array
description: >-
A collection of tokens that can be used as custom properties on the
event and to create fully fledged CRM objects.
items:
$ref: '#/components/schemas/TimelineEventTemplateToken'
TimelineEventTemplate:
required:
- id
- name
- objectType
- tokens
type: object
properties:
createdAt:
type: string
description: >-
The date and time that the Event Template was created, as an ISO
8601 timestamp. Will be null if the template was created before Feb
18th, 2020.
format: date-time
detailTemplate:
type: string
description: >-
This uses Markdown syntax with Handlebars and event-specific data to
render HTML on a timeline when you expand the details.
headerTemplate:
type: string
description: >-
This uses Markdown syntax with Handlebars and event-specific data to
render HTML on a timeline as a header.
id:
type: string
description: The template ID.
name:
type: string
description: The template name.
objectType:
type: string
description: >-
The type of CRM object this template is for. [Contacts, companies,
tickets, and deals] are supported.
tokens:
type: array
description: >-
A collection of tokens that can be used as custom properties on the
event and to create fully fledged CRM objects.
items:
$ref: '#/components/schemas/TimelineEventTemplateToken'
updatedAt:
type: string
description: >-
The date and time that the Event Template was last updated, as an
ISO 8601 timestamp. Will be null if the template was created before
Feb 18th, 2020.
format: date-time
TimelineEventTemplateToken:
required:
- label
- name
- options
- type
type: object
properties:
createdAt:
type: string
description: >-
The date and time that the Event Template Token was created, as an
ISO 8601 timestamp. Will be null if the template was created before
Feb 18th, 2020.
format: date-time
label:
type: string
description: Used for list segmentation and reporting.
name:
type: string
description: >-
The name of the token referenced in the templates. This must be
unique for the specific template. It may only contain alphanumeric
characters, periods, dashes, or underscores (. - _).
objectPropertyName:
type: string
description: >-
The name of the CRM object property. This will populate the CRM
object property associated with the event. With enough of these, you
can fully build CRM objects via the Timeline API.
options:
type: array
description: >-
If type is `enumeration`, we should have a list of options to choose
from.
items:
$ref: '#/components/schemas/TimelineEventTemplateTokenOption'
type:
type: string
description: >-
The data type of the token. You can currently choose from [string,
number, date, enumeration].
enum:
- date
- enumeration
- number
- string
updatedAt:
type: string
description: >-
The date and time that the Event Template Token was last updated, as
an ISO 8601 timestamp. Will be null if the template was created
before Feb 18th, 2020.
format: date-time
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
TimelineEventTemplateTokenOption:
required:
- label
- value
type: object
properties:
label:
type: string
description: The label of the option that is displayed in the front end.
value:
type: string
description: The value of the option that is provided on the occurrence.
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
crm.objects.companies.highly_sensitive.read.v2: ''
crm.objects.companies.highly_sensitive.write.v2: ''
crm.objects.companies.read: ''
crm.objects.companies.sensitive.read.v2: ''
crm.objects.companies.sensitive.write.v2: ''
crm.objects.companies.write: ''
crm.objects.contacts.highly_sensitive.read.v2: ''
crm.objects.contacts.highly_sensitive.write.v2: ''
crm.objects.contacts.read: ''
crm.objects.contacts.sensitive.read.v2: ''
crm.objects.contacts.sensitive.write.v2: ''
crm.objects.contacts.write: ''
crm.objects.deals.highly_sensitive.read.v2: ''
crm.objects.deals.highly_sensitive.write.v2: ''
crm.objects.deals.read: ''
crm.objects.deals.sensitive.read.v2: ''
crm.objects.deals.sensitive.write.v2: ''
crm.objects.deals.write: ''
crm.schemas.companies.read: ''
crm.schemas.companies.write: ''
crm.schemas.contacts.read: ''
crm.schemas.contacts.write: ''
crm.schemas.deals.read: ''
crm.schemas.deals.write: ''
developers-read: ''
developers-write: ''
tickets: ''
tickets.highly_sensitive.v2: ''
tickets.sensitive.v2: ''
timeline: ''
timeline.read: ''
timeline.write: ''
````
{product.name} -
{product.level}
)}