Pins

A pin marks a record as important to one user. Use this resource to pin and unpin contacts, organizations, deals, pipelines, milestones, files, and spaces for your key’s user.

Pins are personal: a pin made through the API applies to your key’s user and nobody else in the account. A record has no pin of its own to read or list; instead, records report whether your key’s user has pinned them. A contact, for example, has a pinned attribute.

post/{record_type}/{record_id}/pin Write key

#Pin a record

Pins a record for your key’s user. Pinning a record that’s already pinned succeeds and changes nothing.

Path parameters

  • record_typestringrequired

    The plural resource name, one of:

    contactsorganizationsdealspipelinesmilestonesfilesspaces
  • record_idstring · uuidrequired

    The id of that record. In the OpenAPI spec each route names it after its type, for example contact_id.

    Show 7 pathsHide paths
    • /contacts/{contact_id}/pin
    • /organizations/{organization_id}/pin
    • /deals/{deal_id}/pin
    • /pipelines/{pipeline_id}/pin
    • /milestones/{milestone_id}/pin
    • /files/{file_id}/pin
    • /spaces/{space_id}/pin

Returns

The ok object, {"ok": "ok"}.

Errors

  • 404record_not_foundNo record of that type with that id is visible to your key.
post/deals/{deal_id}/pin 
curl -X POST https://api.carom.io/deals/6d2a9f14-8b3c-4e7a-a1d5-0c9b8e7f6a52/pin \
  -H "Authorization: Bearer $CAROM_API_KEY"
Response200 
{ "ok": "ok" }
delete/{record_type}/{record_id}/pin Write key

#Unpin a record

Removes your key’s user’s pin from a record. Other users’ pins on the same record are unaffected. Unpinning a record that isn’t pinned succeeds and changes nothing.

Path parameters

Returns

An empty response with status 204.

Errors

  • 404record_not_foundNo record of that type with that id is visible to your key.
delete/deals/{deal_id}/pin 
curl -X DELETE https://api.carom.io/deals/6d2a9f14-8b3c-4e7a-a1d5-0c9b8e7f6a52/pin \
  -H "Authorization: Bearer $CAROM_API_KEY"
Response204 
No content