v1

latestOpenAPI 3.0.12026-07-1462020.1 KB

SampleResponse

Get sample card detail response

Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.

get/crm/v3/extensions/cards/sample-response

Response

successful operation

allItemsLinkUrlstring

URL to a page the integrator has built that displays all details for this card. This URL will be displayed to users under a See more [x] link if there are more than five items in your response, where [x] is the value of itemLabel.

cardLabelstring

The label to be used for the allItemsLinkUrl link (e.g. 'See more tickets'). If not provided, this falls back to the card's title.

responseVersion'v1' | 'v3'

totalCountinteger required

The total number of card properties that will be sent in this response.

All 6 operations