Zum Hauptinhalt springen
PUT
/
integrators
/
timeline
/
v3
/
{appId}
/
event-templates
/
{eventTemplateId}
/
tokens
/
{tokenName}
Mettre à jour un jeton de modèle
curl --request PUT \
  --url https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens/{tokenName} \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "petType edit",
  "options": [
    {
      "value": "dog",
      "label": "Dog"
    },
    {
      "value": "cat",
      "label": "Cat"
    },
    {
      "value": "bird",
      "label": "Bird"
    }
  ]
}'
{
  "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"
    },
    {
      "value": "bird",
      "label": "Bird"
    }
  ]
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubStarter

Authorizations

​
hapikey
string
query
required

Path Parameters

​
eventTemplateId
string
required

L'ID du modèle d'événement.

​
tokenName
string
required

Le nom du jeton.

​
appId
integer
required

L'ID de l'application cible.

Body

application/json

The updated token definition.

State of the token definition for update requests.

​
label
string
required

Utilisé pour la segmentation de listes et le reporting.

Example:

"petType edit"

​
options
object[]

Si le type est enumeration, nous devrions avoir une liste d'options parmi lesquelles choisir.

Example:

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

​
objectPropertyName
string

Le nom de la propriété d'objet du CRM. Cela remplira la propriété d'objet du CRM associée à l'événement. Avec suffisamment de ces éléments, vous pouvez construire entièrement des objets CRM via l'API de chronologie.

Response

successful operation

State of the token definition.

​
name
string
required

Le nom du jeton référencé dans les modèles. Il doit être unique pour le modèle spécifique. Il ne peut contenir que des caractères alphanumériques, des points, des tirets ou des tirets bas (. - _).

Example:

"petType"

​
label
string
required

Utilisé pour la segmentation de listes et le reporting.

Example:

"Pet Type"

​
type
enum<string>
required

Le type de données du jeton. Vous pouvez actuellement choisir parmi [chaîne, nombre, date, énumération].

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

"enumeration"

​
createdAt
string<date-time>

La date et l'heure de création du jeton de modèle d'événement, sous la forme d'un horodatage ISO 8601. Sera nul si le modèle a été créé avant le 18 février 2020.

Example:

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

​
options
object[]

Si le type est enumeration, nous devrions avoir une liste d'options parmi lesquelles choisir.

Example:

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

​
objectPropertyName
string

Le nom de la propriété d'objet du CRM. Cela remplira la propriété d'objet du CRM associée à l'événement. Avec suffisamment de ces éléments, vous pouvez construire entièrement des objets CRM via l'API de chronologie.

Example:

"customPropertyPetType"

​
updatedAt
string<date-time>

La date et l'heure de la dernière mise à jour du jeton de modèle d'événement, sous la forme d'un horodatage ISO 8601. Sera nul si le modèle a été créé avant le 18 février 2020.

Example:

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

⌘I