Sign in

v1

latestOpenAPI 3.0.12026-07-1462020.1 KB
Cards

Create a new card

Defines a new card that will become active on an account when this app is installed.

post/crm/v3/extensions/cards/{appId}

Path parameters

appIdinteger required

The ID of the target app.

Request body

titlestring required

The top-level title for this card. Displayed to users in the CRM UI.

Example request

{
  "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"
}

Response

successful operation

createdAtstring date-time

When this card was created.

idstring required

Generated unique ID for card.

titlestring required

Displayed title of this card.

updatedAtstring date-time

The last time this card was updated.

Example response

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