Obtenez une carte. - HubSpot docs

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.

Marketing HubGratuit

Sales HubGratuit

Service HubGratuit

Content HubGratuit

Authorizations

hapikey

string

query

required

Path Parameters

appId

integer<int32>

required

L'ID de l'application cible.

cardId

string

required

L'ID de la carte cible.

Response

successful operation

actions

object

required

Configuration for custom user actions on cards.

Anzeigen untergeordnete attribute

actions.baseUrls

string[]

required

Une liste de préfixes d'URL qui seront acceptés pour les URL d'action de carte. Si votre réponse de récupération de données inclut une URL d'action qui ne commence pas par l'une de ces valeurs, cela entraînera une erreur et la carte ne sera pas affichée.

Example:

{
  "baseUrls": ["https://www.example.com/hubspot"]
}

auditHistory

object[]

required

Une liste des actions effectuées sur la carte, y compris la création, la suppression et les mises à jour.

Anzeigen untergeordnete attribute

auditHistory.actionType

enum<string>

required

Le type d'action effectué, avec les valeurs possibles : CRÉER, SUPPRIMER, METTRE À JOUR.

Verfügbare Optionen:

CREATE,

DELETE,

UPDATE

auditHistory.applicationId

integer<int32>

required

L'ID de l'application associée à la carte.

auditHistory.authSource

enum<string>

required

Source d'authentification pour l'action, avec les valeurs possibles suivantes : APPLICATION, EXTERNE, INTERNE.

Verfügbare Optionen:

APP,

EXTERNAL,

INTERNAL

auditHistory.changedAt

integer<int64>

required

L'horodatage indiquant quand le changement s'est produit.

auditHistory.initiatingUserId

integer<int32>

required

L'ID de l'utilisateur qui a initié l'action.

auditHistory.objectTypeId

integer<int32>

required

L'ID de la carte.

display

object

required

Configuration for displayed info on a card

Anzeigen untergeordnete attribute

display.properties

object[]

required

Propriétés d'affichage des cartes. Elles seront affichées sous forme de paires « libellé : valeur » dans l'UI de la carte. Consultez la carte exemple dans les docs d'aperçu pour plus d'informations.

Anzeigen untergeordnete attribute

display.properties.dataType

enum<string>

required

Type des données représentées par cette propriété.

Verfügbare Optionen:

BOOLEAN,

CURRENCY,

DATE,

DATETIME,

EMAIL,

LINK,

NUMERIC,

STATUS,

STRING

display.properties.label

string

required

Le libellé de cette propriété telle que vous souhaitez qu'elle soit affichée aux utilisateurs.

display.properties.name

string

required

Un identifiant interne pour cette propriété. Cette valeur doit être unique TODO.

display.properties.options

object[]

required

Un tableau d'options disponibles qui peuvent être affichées. Utilisé uniquement lorsque « dataType » est « STATUT ».

Anzeigen untergeordnete attribute

display.properties.options.label

string

required

Le texte qui sera affiché aux utilisateurs pour cette option.

display.properties.options.name

string

required

Nom unique compatible JSON pour l'option.

display.properties.options.type

enum<string>

required

Le type de statut.

Verfügbare Optionen:

DANGER,

DEFAULT,

INFO,

SUCCESS,

WARNING

fetch

object

required

Anzeigen untergeordnete attribute

fetch.objectTypes

object[]

required

Un tableau de types d'objets CRM où cette carte doit être affichée. HubSpot appellera votre URL de récupération de données chaque fois qu'un utilisateur visite une page de fiches d'informations des types définis ici.

Anzeigen untergeordnete attribute

fetch.objectTypes.name

enum<string>

required

Un type d'objet CRM où cette carte doit être affichée.

Verfügbare Optionen:

companies,

contacts,

deals,

marketing_events,

tickets

fetch.objectTypes.propertiesToSend

string[]

required

Un tableau de propriétés qui doivent être envoyées à l'URL cible de cette carte lorsque la demande de récupération de données est effectuée. Doit être des propriétés valides pour le type d'objet CRM correspondant.

fetch.targetUrl

string

required

URL du point de terminaison de service répondant avec les détails de la carte. HubSpot appellera ce point de terminaison chaque fois qu'un utilisateur visite la page d'une fiche d'informations du CRM où cette carte doit être affichée.

string

required

L'ID unique de la carte.

title

string

required

Le titre de niveau supérieur pour cette carte, affiché aux utilisateurs dans l'interface CRM.

createdAt

string<date-time>

La date et l'heure de création de la carte.

updatedAt

string<date-time>

La date et heure de la dernière mise à jour de la carte.

Analytics et événements

CRM

Authorizations

Path Parameters

Response