Atualizar um cartão - HubSpot docs

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing HubGrátis

Sales HubGrátis

Service HubGrátis

Content HubGrátis

Authorizations

hapikey

string

query

required

Path Parameters

appId

integer<int32>

required

O ID do aplicativo de destino.

cardId

string

required

O ID do cartão a ser atualizado.

Body

application/json

Card definition fields to be updated.

Body for a patch with optional fields

actions

object

Configuration for custom user actions on cards.

Mostrar atributos filhos

actions.baseUrls

string[]

required

Uma lista de prefixos de URL que serão aceitos para URLs de ação do cartão. Se a resposta de busca de dados incluir um URL de ação que não comece com um desses valores, isso resultará em um erro e o cartão não será exibido.

Example:

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

display

object

Configuration for displayed info on a card

Mostrar atributos filhos

display.properties

object[]

required

Propriedades de exibição do cartão. Estas serão renderizadas como pares "rótulo : valor" na interface do cartão. Consulte o exemplo de cartão na documentação de visão geral para obter mais detalhes.

Mostrar atributos filhos

display.properties.dataType

enum<string>

required

O tipo de dados representado por esta propriedade.

Opções disponíveis:

BOOLEAN,

CURRENCY,

DATE,

DATETIME,

EMAIL,

LINK,

NUMERIC,

STATUS,

STRING

display.properties.label

string

required

O rótulo desta propriedade como você gostaria que fosse exibido aos usuários.

display.properties.name

string

required

Um identificador interno para esta propriedade. Este valor deve ser TODO exclusivo.

display.properties.options

object[]

required

Uma matriz de opções disponíveis que podem ser exibidas. Usado apenas quando "dataType" é "STATUS".

Mostrar atributos filhos

display.properties.options.label

string

required

O texto que será exibido aos usuários para esta opção.

display.properties.options.name

string

required

Nome exclusivo compatível com JSON para a opção.

display.properties.options.type

enum<string>

required

O tipo de status.

Opções disponíveis:

DANGER,

DEFAULT,

INFO,

SUCCESS,

WARNING

fetch

object

Variant of CardFetchBody with fields as optional for patches

Mostrar atributos filhos

fetch.objectTypes

object[]

required

Uma matriz de tipos de objeto do CRM em que este cartão deve ser exibido. O HubSpot chamará o URL de destino sempre que um usuário visitar uma página de registro dos tipos definidos aqui.

Mostrar atributos filhos

fetch.objectTypes.name

enum<string>

required

Um tipo de objeto do CRM em que este cartão deve ser exibido.

Opções disponíveis:

companies,

contacts,

deals,

marketing_events,

tickets

fetch.objectTypes.propertiesToSend

string[]

required

Uma matriz de propriedades que devem ser enviadas para o URL de destino deste cartão quando a solicitação de busca de dados for feita. Devem ser propriedades válidas para o tipo de objeto do CRM correspondente.

fetch.cardType

enum<string>

Um campo obsoleto para determinar o tipo de cartão retornado.

Opções disponíveis:

EXTERNAL,

SERVERLESS

fetch.serverlessFunction

string

Um campo obsoleto para especificar a funcionalidade sem servidor com o cartão

fetch.targetUrl

string

O URL de um ponto de extremidade que responderá com detalhes para este cartão. O HubSpot chamará este ponto de extremidade sempre que um usuário visitar uma página de registro do CRM onde este cartão deve ser exibido.

title

string

O título de nível superior para este cartão. Exibido para os usuários na UI do CRM.

Response

successful operation

actions

object

required

Configuration for custom user actions on cards.

Mostrar atributos filhos

actions.baseUrls

string[]

required

Example:

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

auditHistory

object[]

required

Uma lista das ações realizadas no cartão, incluindo criação, exclusão e atualizações.

Mostrar atributos filhos

auditHistory.actionType

enum<string>

required

O tipo de ação realizada, com os valores possíveis: CRIAR, EXCLUIR, ATUALIZAR.

Opções disponíveis:

CREATE,

DELETE,

UPDATE

auditHistory.applicationId

integer<int32>

required

O ID do aplicativo associado ao cartão.

auditHistory.authSource

enum<string>

required

A fonte de autenticação da ação, com os valores possíveis: APLICATIVO, EXTERNO, INTERNO.

Opções disponíveis:

APP,

EXTERNAL,

INTERNAL

auditHistory.changedAt

integer<int64>

required

A data e a hora da alteração.

auditHistory.initiatingUserId

integer<int32>

required

O ID do usuário que iniciou a ação.

auditHistory.objectTypeId

integer<int32>

required

O ID do cartão.

display

object

required

Configuration for displayed info on a card

Mostrar atributos filhos

display.properties

object[]

required

Mostrar atributos filhos

display.properties.dataType

enum<string>

required

O tipo de dados representado por esta propriedade.

Opções disponíveis:

BOOLEAN,

CURRENCY,

DATE,

DATETIME,

EMAIL,

LINK,

NUMERIC,

STATUS,

STRING

display.properties.label

string

required

O rótulo desta propriedade como você gostaria que fosse exibido aos usuários.

display.properties.name

string

required

Um identificador interno para esta propriedade. Este valor deve ser TODO exclusivo.

display.properties.options

object[]

required

Uma matriz de opções disponíveis que podem ser exibidas. Usado apenas quando "dataType" é "STATUS".

Mostrar atributos filhos

display.properties.options.label

string

required

O texto que será exibido aos usuários para esta opção.

display.properties.options.name

string

required

Nome exclusivo compatível com JSON para a opção.

display.properties.options.type

enum<string>

required

O tipo de status.

Opções disponíveis:

DANGER,

DEFAULT,

INFO,

SUCCESS,

WARNING

fetch

object

required

Mostrar atributos filhos

fetch.objectTypes

object[]

required

Uma matriz de tipos de objeto do CRM em que este cartão deve ser exibido. O HubSpot chamará o URL de busca de dados sempre que um usuário visitar uma página de registro dos tipos definidos aqui.

Mostrar atributos filhos

fetch.objectTypes.name

enum<string>

required

Um tipo de objeto do CRM em que este cartão deve ser exibido.

Opções disponíveis:

companies,

contacts,

deals,

marketing_events,

tickets

fetch.objectTypes.propertiesToSend

string[]

required

fetch.targetUrl

string

required

O URL de um endpoint de serviço que responderá com detalhes do cartão. O HubSpot chamará este ponto de extremidade sempre que um usuário visitar uma página de registro do CRM onde este cartão deve ser exibido.

string

required

O ID exclusivo do cartão.

title

string

required

O título de nível superior para este cartão; exibido para os usuários na UI do CRM.

createdAt

string<date-time>

A data e a hora em que o cartão foi criado.

updatedAt

string<date-time>

A data e a hora da última atualização do cartão.

Análise e eventos

CRM

Authorizations

Path Parameters

Body

Response