Add tokens to an existing template

Adicionar tokens a um modelo existente

curl --request POST \
  --url 'https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "objectPropertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey="

payload = {
    "label": "<string>",
    "name": "<string>",
    "options": [
        {
            "label": "<string>",
            "value": "<string>"
        }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "objectPropertyName": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    name: '<string>',
    options: [{label: '<string>', value: '<string>'}],
    createdAt: '2023-11-07T05:31:56Z',
    objectPropertyName: '<string>',
    updatedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'name' => '<string>',
    'options' => [
        [
                'label' => '<string>',
                'value' => '<string>'
        ]
    ],
    'createdAt' => '2023-11-07T05:31:56Z',
    'objectPropertyName' => '<string>',
    'updatedAt' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey="

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"objectPropertyName\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"objectPropertyName\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"objectPropertyName\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "type": "date",
  "createdAt": "2023-11-07T05:31:56Z",
  "objectPropertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
  }
}

POST

integrators

timeline

{appId}

event-templates

{eventTemplateId}

tokens

Adicionar tokens a um modelo existente

curl --request POST \
  --url 'https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "objectPropertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey="

payload = {
    "label": "<string>",
    "name": "<string>",
    "options": [
        {
            "label": "<string>",
            "value": "<string>"
        }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "objectPropertyName": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    name: '<string>',
    options: [{label: '<string>', value: '<string>'}],
    createdAt: '2023-11-07T05:31:56Z',
    objectPropertyName: '<string>',
    updatedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'label' => '<string>',
    'name' => '<string>',
    'options' => [
        [
                'label' => '<string>',
                'value' => '<string>'
        ]
    ],
    'createdAt' => '2023-11-07T05:31:56Z',
    'objectPropertyName' => '<string>',
    'updatedAt' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey="

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"objectPropertyName\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"objectPropertyName\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens?hapikey=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"name\": \"<string>\",\n  \"options\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"objectPropertyName\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "label": "<string>",
  "name": "<string>",
  "options": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "type": "date",
  "createdAt": "2023-11-07T05:31:56Z",
  "objectPropertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
  }
}

Supported products

Autorizações

hapikey

string

query

obrigatório

Parâmetros de caminho

appId

integer<int32>

obrigatório

eventTemplateId

string

obrigatório

Corpo

application/json

label

string

obrigatório

Usado para segmentação de listas e relatórios.

name

string

obrigatório

O nome do token referenciado nos modelos. Deve ser exclusivo para o modelo específico. Pode conter apenas caracteres alfanuméricos, pontos, traços ou sublinhados (. - _).

options

object[]

obrigatório

Se o tipo for "enumeration", devemos ter uma lista de opções para escolher.

Show child attributes

type

enum<string>

obrigatório

O tipo de dados do token. Atualmente, você pode escolher entre [string, número, data, enumeração].

Opções disponíveis:

date,

enumeration,

number,

string

createdAt

string<date-time>

A data e hora em que o Token do modelo de evento foi criado, como um registro de data e hora ISO 8601. Será nulo se o modelo foi criado antes de 18 de fevereiro de 2020.

objectPropertyName

string

O nome da propriedade do objeto do CRM. Isso irá preencher a propriedade do objeto do CRM associada ao evento. Com uma quantidade suficiente de nomes, você pode construir completamente objetos do CRM utilizando a API de linha do tempo.

updatedAt

string<date-time>

A data e hora em que o Token do modelo de evento foi atualizado pela última vez, como um registro de data e hora ISO 8601. Será nulo se o modelo foi criado antes de 18 de fevereiro de 2020.

Resposta

successful operation

label

string

obrigatório

Usado para segmentação de listas e relatórios.

name

string

obrigatório

O nome do token referenciado nos modelos. Deve ser exclusivo para o modelo específico. Pode conter apenas caracteres alfanuméricos, pontos, traços ou sublinhados (. - _).

options

object[]

obrigatório

Se o tipo for "enumeration", devemos ter uma lista de opções para escolher.

Show child attributes

type

enum<string>

obrigatório

O tipo de dados do token. Atualmente, você pode escolher entre [string, número, data, enumeração].

Opções disponíveis:

date,

enumeration,

number,

string

createdAt

string<date-time>

A data e hora em que o Token do modelo de evento foi criado, como um registro de data e hora ISO 8601. Será nulo se o modelo foi criado antes de 18 de fevereiro de 2020.

objectPropertyName

string

updatedAt

string<date-time>

A data e hora em que o Token do modelo de evento foi atualizado pela última vez, como um registro de data e hora ISO 8601. Será nulo se o modelo foi criado antes de 18 de fevereiro de 2020.

Última modificação em 13 de abril de 2026

Conta e configurações

Gerenciamento de aplicativo

Autenticação

Automação

CMS

Preferências de comunicação

Conversas

CRM

Eventos

Arquivos

Marketing

Relatórios

Agendador

Webhooks

Add tokens to an existing template

Autorizações

Parâmetros de caminho

Corpo

Resposta