Zum Hauptinhalt springen
GET
/
crm
/
v3
/
extensions
/
cards-dev
/
sample-response
Antwort mit Beispielkartendetails abrufen
curl --request GET \
  --url https://api.hubapi.com/crm/v3/extensions/cards-dev/sample-response
{
  "totalCount": 1,
  "allItemsLinkUrl": "https://example.com/all-items-link-url",
  "cardLabel": "Tickets",
  "topLevelActions": {
    "settings": {
      "type": "IFRAME",
      "width": 640,
      "height": 480,
      "url": "https://example.com/iframe-contents",
      "label": "Edit",
      "propertyNamesIncluded": [
        "some_crm_property"
      ]
    },
    "primary": {
      "type": "IFRAME",
      "width": 640,
      "height": 480,
      "url": "https://example.com/primary-iframe",
      "label": "test_label_primary",
      "propertyNamesIncluded": []
    },
    "secondary": [
      {
        "type": "IFRAME",
        "width": 640,
        "height": 480,
        "url": "https://example.com/secondary-iframe",
        "label": "test_label_secondary",
        "propertyNamesIncluded": []
      }
    ]
  },
  "sections": [
    {
      "id": "123",
      "title": "API-22: APIs working too fast",
      "linkUrl": "http://example.com/1",
      "tokens": [
        {
          "name": "created",
          "label": "test_label",
          "dataType": "DATE",
          "value": "2016-08-04"
        }
      ],
      "actions": [
        {
          "type": "ACTION_HOOK",
          "httpMethod": "POST",
          "url": "https://example.com/action-hook-frame",
          "label": "action-hook-label",
          "propertyNamesIncluded": [
            "email",
            "firstName"
          ]
        },
        {
          "type": "ACTION_HOOK",
          "confirmation": {
            "prompt": "action-confirmation-body-prompt",
            "confirmButtonLabel": "Continue",
            "cancelButtonLabel": "Cancel"
          },
          "httpMethod": "POST",
          "url": "https://example.com/confirmation-action-hook",
          "label": "confirmation-hook-label",
          "propertyNamesIncluded": []
        },
        {
          "type": "IFRAME",
          "width": 640,
          "height": 480,
          "url": "https://example.com/iframe-action-label",
          "label": "iframe-action-label",
          "propertyNamesIncluded": [
            "property1",
            "property2",
            "property3"
          ]
        }
      ]
    }
  ],
  "responseVersion": "v3"
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubKostenlos
Sales HubSales HubKostenlos
Service HubService HubKostenlos
Content HubContent HubKostenlos

Response

successful operation

The card details payload, sent to HubSpot by an app in response to a data fetch request when a user visits a CRM record page.

​
totalCount
integer
required

Die Gesamtzahl der Karteneigenschaften, die in dieser Antwort gesendet werden

​
responseVersion
enum<string>
Available options:
v1,
v3
​
cardLabel
string

Die Bezeichnung, die für den Link „allItemsLinkUrl“ verwendet werden soll (z. B. „Weitere Tickets anzeigen“). Bei fehlender Angabe wird der Titel der Karte verwendet.

​
allItemsLinkUrl
string

URL zu einer Seite, die der Integrator erstellt hat und die alle Details zu dieser Karte anzeigt. Diese URL wird den Benutzern unter einem Link „Weitere [x] anzeigen“ angezeigt, wenn Ihre Antwort mehr als fünf Elemente enthält, wobei „x“ der Wert von „itemLabel“ ist.

​
topLevelActions
object
​
sections
object[]

Eine Liste mit bis zu fünf gültigen Kartenunterkategorien

⌘I