Bulk Labels Upload API (Early Access)

In this section, we will explain the BalkanID Labels CSV format.

ID	Name*	Icon	Color	Status	Background Color	Text Color	Light Background Color	Light Text Color	Dark Background Color	Dark Text Color	Type*
01H9VNFTZD1T44TCSKGEBWNTZD	Engineering	https://example.com/icons/engineering.svg	secondary		#FFFFFF	#000000	#FFFFFF	#000000	#FFFFFF	#000000	entitlement
02H9VNFTZD1T44TCSKGEBWNTZD	Privileged	https://example.com/icons/privileged.svg	secondary	deleted	#FFFFFF	#000000	#FFFFFF	#000000	#FFFFFF	#000000	entitlement
	SoD										employee

In the above sample csv,

Row 1, has an ID mentioned in it, this is update the data of the label
associated with the ID "01X12A" and other columns, i.e., Icon and Color

Row 2, has an ID mentioned in it, along with status "deleted", this will
delete the label associated with the ID "01X13S"

Row 3, has no ID mentioned, this will create a new label with name "Test
Label 1"

NOTE: Columns with * are required always.

Column Name	Column Description
ID	ID of the label if already exists. It should be used to update.
Name	The name of the label. It appears in the applications.
Icon	The icon of the label. It appears in the applications.
Color	The color of the label. ex: "primary","secondary"
Status	The status of the label. Takes "deleted" for now. If deleted, it deletes the label
Background Color	The background color of the label. It appears in the applications.
Text Color	The text color of the label. It appears in the applications.
Light Background Color	The light background color of the label. It appears in the applications.
Light Text Color	The light text color of the label. It appears in the applications.
Dark Background Color	The dark background color of the label. It appears in the applications.
Dark Text Color	The dark text color of the label. It appears in the applications.
Type	The type of the label, used to identify the type of the label. Currently, it only supports "entitlement" and "employee"

After retrieving the pre-signed URL in the previous step, all that remains
is to upload the CSV in BalkanID Labels CSV format to the pre-signed URL.

Below is a summary of the request using curl:

The request URL is the pre-signed URL from previous step.

The request method is PUT.

Required request body is the CSV in BalkanID Labels CSV
format.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request