August 22, 2022

This document provides an overview of the Aug 2, 2022 release of Karbon's Public API.

In summary, we have created an API endpoint that makes it possible to retrieve or update a single

.

1. JSONCopyCopied!

   GET Business Card by BusinessCardKey
2. JSONCopyCopied!

   PUT Business Card by BusinessCardKey

---

JSONCopyCopied!

GET Business Card by BusinessCardKey

Endpoint:

We have added a new endpoint that, when used with

method, retrieves a Business Card using its .

To make an API call to this endpoint using

method, replace { parameter in the endpoint with a valid .

Note: You can still retrieve a

through the , and APIs.

Example use case

You want to retrieve a Business Card associated with a Karbon entity. To receive the

, use method on the following endpoint and replace with Karbon generated key unique to a Business Card.

Endpoint:

---

JSONCopyCopied!

PUT Business Card by BusinessCardKey

Endpoint:

We have also enabled

method on the same endpoint, allowing you to update a Business Card using its .

To make an API call to this endpoint using

method:

• Replace
  JSONCopyCopied!

  {BusinessCardKey}
  parameter in the endpoint with a valid
  JSONCopyCopied!

  BusinessCardKey
• Ensure the request payload includes all
  JSONCopyCopied!

  BusinessCard
  properties
  • Supply changes to the properties that you want to update
  • Supply original value to the properties that you don't want to update

Note

• The
  JSONCopyCopied!

  EntityType
  property of the
  JSONCopyCopied!

  BusinessCard
  must match the entity (Contact, Organization or ClientGroup) it belongs to.
• Setting the value of
  JSONCopyCopied!

  IsPrimaryCard
  parameter will have no effect for Business Cards associated with Organizations, ClientGroups and Contacts.
• A future version of this API endpoint will include validation for the
  JSONCopyCopied!

  IsPrimaryCard
  property.
• You can still update a
  JSONCopyCopied!

  BusinessCard
  using
  JSONCopyCopied!

  PUT
  method against Contacts, Organizations or ClientGroups API. However, those API endpoints require you to send a payload, containing a full data set for that entity (i.e., entity details, all other
  JSONCopyCopied!

  BusinessCards
  and any
  JSONCopyCopied!

  AccountingDetails
  ).
• Updating multiple Business Cards using the Contacts API will set the first
  JSONCopyCopied!

  BusinessCard
  as the primary card. In such scenario, it disregards the value of
  JSONCopyCopied!

  IsPrimaryCard
  property for all objects within the
  JSONCopyCopied!

  BusinessCards
  array.

Example use case

You want to update a Business Card associated with a Karbon entity. To update the

, use method on the endpoint given below. Replace with Karbon generated key unique to a Business Card and supply a request payload with all properties associated with the .

Endpoint: