Create a CRM card

Define una nueva tarjeta que se activará en una cuenta cuando se instale esta aplicación.

POST /crm/v3/extensions/cards-dev/{appId}

Crear una tarjeta nueva

cURL

curl --request POST \
  --url https://api.hubapi.com/crm/v3/extensions/cards-dev/{appId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actions": {
    "baseUrls": [
      "https://www.example.com/hubspot"
    ]
  },
  "display": {
    "properties": [
      {
        "dataType": "STRING",
        "label": "Pets Name",
        "name": "pet_name"
      }
    ]
  },
  "fetch": {
    "objectTypes": [
      {
        "name": "contacts",
        "propertiesToSend": [
          "email",
          "firstname"
        ]
      }
    ],
    "targetUrl": "https://www.example.com/hubspot/target"
  },
  "title": "PetSpot"
}
'

201

{
  "actions": {
    "baseUrls": [
      "https://www.example.com/hubspot"
    ]
  },
  "auditHistory": [
    {
      "applicationId": 123,
      "changedAt": 123,
      "initiatingUserId": 123,
      "objectTypeId": 123
    }
  ],
  "display": {
    "properties": [
      {
        "label": "<string>",
        "name": "<string>",
        "options": [
          {
            "label": "<string>",
            "name": "<string>"
          }
        ]
      }
    ]
  },
  "fetch": {
    "objectTypes": [
      {
        "propertiesToSend": [
          "<string>"
        ]
      }
    ],
    "targetUrl": "<string>"
  },
  "id": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Supported products

Autorizaciones

Authorization · string · header · requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de ruta

appId · integer<int32> · requerido

El ID de la aplicación que contendrá la tarjeta del CRM anterior

Cuerpo

application/json

State of card definition to be created

actions · object · requerido

Configuration for custom user actions on cards.

Show child attributes

Ejemplo:

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

display · object · requerido

Configuration for displayed info on a card

Show child attributes

fetch · object · requerido

Configuration for this card's data fetch request.

Show child attributes

title · string · requerido

El título principal de esta tarjeta, que se muestra a los usuarios en la interfaz de usuario del CRM. Es una cadena.

Respuesta

201

application/json

successful operation

actions · object · requerido

Configuration for custom user actions on cards.

Show child attributes

Ejemplo:

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

auditHistory · object[] · requerido

Una lista de acciones realizadas en la tarjeta, que incluyen creación, eliminación y actualizaciones.

Show child attributes

display · object · requerido

Configuration for displayed info on a card

Show child attributes

fetch · object · requerido

Show child attributes

id · string · requerido

El ID único de la tarjeta.

title · string · requerido

El título de nivel superior de esta tarjeta. Se muestra a los usuarios en la UI del CRM.

createdAt · string<date-time>

La fecha y hora en que se creó la tarjeta.

updatedAt · string<date-time>

La fecha y hora en que se actualizó por última vez la tarjeta.