Zum Hauptinhalt springen
POST
/
integrators
/
timeline
/
v3
/
{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 \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "petType",
  "label": "Pet Type",
  "type": "enumeration",
  "createdAt": "2020-02-12T20:58:26Z",
  "updatedAt": "2020-02-12T20:58:26Z",
  "objectPropertyName": "customPropertyPetType",
  "options": [
    {
      "value": "dog",
      "label": "Dog"
    },
    {
      "value": "cat",
      "label": "Cat"
    }
  ]
}'
{
  "name": "petType",
  "type": "enumeration",
  "createdAt": "2020-02-12T20:58:26Z",
  "updatedAt": "2020-02-12T20:58:26Z",
  "label": "Pet Type",
  "options": [
    {
      "value": "dog",
      "label": "Dog"
    },
    {
      "value": "cat",
      "label": "Cat"
    }
  ]
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubStarter

Authorizations

​
hapikey
string
query
required

Path Parameters

​
eventTemplateId
string
required

O ID do modelo do evento.

​
appId
integer
required

O ID do aplicativo de destino.

Body

application/json

The new token definition.

State of the token definition.

​
name
string
required

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 (. - _).

Example:

"petType"

​
label
string
required

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

Example:

"Pet Type"

​
type
enum<string>
required

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

Available options:
date,
enumeration,
number,
string
Example:

"enumeration"

​
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.

Example:

"2020-02-12T20:58:26.000+00:00"

​
options
object[]

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

Example:

"[{\"label\":\"Dog\",\"value\":\"dog\"},{\"label\":\"Cat\",\"value\":\"cat\"}]"

​
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.

Example:

"customPropertyPetType"

​
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.

Example:

"2020-02-12T20:58:26.000+00:00"

Response

successful operation

State of the token definition.

​
name
string
required

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 (. - _).

Example:

"petType"

​
label
string
required

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

Example:

"Pet Type"

​
type
enum<string>
required

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

Available options:
date,
enumeration,
number,
string
Example:

"enumeration"

​
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.

Example:

"2020-02-12T20:58:26.000+00:00"

​
options
object[]

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

Example:

"[{\"label\":\"Dog\",\"value\":\"dog\"},{\"label\":\"Cat\",\"value\":\"cat\"}]"

​
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.

Example:

"customPropertyPetType"

​
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.

Example:

"2020-02-12T20:58:26.000+00:00"

⌘I