Developer Hub
Request Demo
Request Demo
Support
  1. Configuration
  • Getting Started
    • Introduction
  • API Reference
    • Admins
      • Bulk Admins Download API (Early Access)
    • Apps
      • Bulk Apps Download API (Early Access)
    • Business Owners
      • Bulk Business Owners Download API (Early Access)
      • Bulk Business Owners Upload API (Early Access)
    • Campaigns
      • Bulk Campaigns Download API (Early Access)
      • Bulk Campaigns Upload API (Early Access)
    • Configuration
      • Bulk Applied Labels Upload API (Early Access)
        POST
      • Bulk Entity Finding Rules Download API (Early Access)
        POST
      • Bulk Custom Insights (Entity Rules) Download API (Early Access)
        POST
      • Bulk Filters Download API (Early Access)
        POST
      • Bulk Filters Upload API (Early Access)
        POST
      • Bulk Findings Download API (Early Access)
        POST
      • Bulk Findings Upload API (Early Access)
        POST
      • Bulk Labels Download API (Early Access)
        POST
      • Bulk Labels Upload API (Early Access)
        POST
      • Bulk Privileged Download API (Early Access)
        POST
      • Bulk Privileged Upload API (Early Access)
        POST
      • Bulk RBAC Download API (Early Access)
        POST
      • Bulk RBAC Upload API (Early Access)
        POST
      • Bulk RBAC2 Download API (Early Access)
        POST
      • Bulk RBAC2 Upload API (Early Access)
        POST
      • Bulk Rules Download API (Early Access)
        POST
      • Bulk Rules Upload API (Early Access)
        POST
    • Employees
      • Bulk Employees Download API (Early Access)
      • Bulk Employees Upload API (Early Access)
    • Entitlements
      • Bulk Entitlements Download API (Early Access)
      • Bulk Entitlements Upload API (Early Access)
    • Entities
      • Bulk Entities Download API (Early Access)
      • Bulk Entities Upload API (Early Access)
    • EntityInsights
      • Bulk Entity Insights Download API (Early Access)
      • Bulk Entity Insights Upload API (Early Access)
    • EntityRelations
      • Bulk Entity Relations Download API (Early Access)
      • Bulk Entity Relations Upload API (Early Access)
    • EntityRBAC
      • Bulk Entity RBAC Download API
      • Bulk Entity RBAC Upload API
    • Integrations
      • Bulk Integrations Download API (Early Access)
      • Bulk Integrations Upload API (Early Access)
    • Purposes
      • Bulk Purposes Download API (Early Access)
      • Bulk Purposes Upload API (Early Access)
    • Relations
      • Bulk Relations Download API (Early Access)
      • Bulk Relations Upload API (Early Access)
    • Requests
      • Bulk Requests Download API (Early Access)
      • Bulk Requests Upload API (Early Access)
    • Reviews
      • Bulk Reviews Download API (Early Access)
      • Bulk Reviews Upload API (Early Access)
    • Playbooks
      • Bulk Playbook Templates Download API (Early Access)
      • Bulk Playbook Templates API (Early Access)
    • Webhooks
      • Bulk Webhook Templates Download API (Early Access)
      • Bulk Webhook Templates API (Early Access)
  • Playbooks
    • Overview
  1. Configuration

Bulk Labels Upload API (Early Access)

POST
https://app.balkan.id/api/rest/v0/labels/upload-url

BalkanID Labels Upload CSV Format#

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

Sample CSV#

IDName*IconColorStatusBackground ColorText ColorLight Background ColorLight Text ColorDark Background ColorDark Text ColorType*
01H9VNFTZD1T44TCSKGEBWNTZDEngineeringhttps://example.com/icons/engineering.svgsecondary#FFFFFF#000000#FFFFFF#000000#FFFFFF#000000entitlement
02H9VNFTZD1T44TCSKGEBWNTZDPrivilegedhttps://example.com/icons/privileged.svgsecondarydeleted#FFFFFF#000000#FFFFFF#000000#FFFFFF#000000entitlement
SoDemployee
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 Definitions#
Column NameColumn Description
IDID of the label if already exists. It should be used to update.
NameThe name of the label. It appears in the applications.
IconThe icon of the label. It appears in the applications.
ColorThe color of the label. ex: "primary","secondary"
StatusThe status of the label. Takes "deleted" for now. If deleted, it deletes the label
Background ColorThe background color of the label. It appears in the applications.
Text ColorThe text color of the label. It appears in the applications.
Light Background ColorThe light background color of the label. It appears in the applications.
Light Text ColorThe light text color of the label. It appears in the applications.
Dark Background ColorThe dark background color of the label. It appears in the applications.
Dark Text ColorThe dark text color of the label. It appears in the applications.
TypeThe type of the label, used to identify the type of the label. Currently, it only supports "entitlement" and "employee"

Upload the CSV file via the pre-signed URL#

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

Header Params
X-Api-Key-ID
string 
optional
X-Api-Key-Secret
string 
optional
Content-Type
string 
optional
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.balkan.id/api/rest/v0/labels/upload-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json'

Responses

🟢200OK
application/json
upload url response
Body
Upload URL endpoint response
url
string 
required
The value is the pre-signed URL to which to upload your CSV file.
Example
{
    "url": "string"
}
🔴500Server Error
Modified at 2025-04-10 03:44:22
Previous
Bulk Labels Download API (Early Access)
Next
Bulk Privileged Download API (Early Access)
Built with