Bulk Campaigns Upload API (Early Access)

BalkanID Campaigns Upload CSV Format

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

Sample CSV

Name*	Description	Start Date*	End Date*	Is Published*	Updated At*	Updated By*	Status
CSV campaign 1	This is campaign 1	2023-12-03T09:00:00-05:00	2023-12-04T18:00:00-05:00	FALSE	2023-12-03T09:00:00-05:00	andy@example.com
CSV campaign 2	This is campaign 2	2023-12-03T09:00:00+05:30	2023-12-04T18:00:00+05:30	TRUE	2023-12-03T09:00:00+05:30	andy@example.com	deleted
CSV campaign 3	This is campaign 3	2023-12-03T09:00:00+05:30	2023-12-04T18:00:00+05:30	TRUE	2023-12-03T09:00:00+05:30	andy@example.com

In above CSV,

Row 1 is a new campaign with name "CSV campaign 1" and description "This is campaign 1" and is published as false

Row 2 is a pre-existing campaign with name "CSV campaign 2" and has status deleted, which means it will be deleted from the system

Row 3 is a pre-existing campaign with name "CSV campaign 3" and has status empty, which means it will be updated with the new values

NOTE:
Columns with * are required always.
You cannot convert a published campaign to a draft campaign. If you want to do so, you will have to create a new campaign with the same name and description and set the isPublished flag to false.
You can only update the Description, Start Date, and End Date fields of a campaign.
2 Campaigns cannot have the same name.

Column Definitions

Column name	Column Description
Name	Required - Name of the campaign
Description	Optional - Description of the campaign
Start Date	Required - Date and time of starting the campaign with timezone
End Date	Required - Date and time of ending the campaign with timezone
Is Published	Required - Whether the campaign is published or not
Updated At	Required - Date and time of updating the campaign with timezone
Updated By	Required - Email of the user who updated the campaign
Status	Optional - Status of the campaign. Currently accepts "deleted" and "aborted". if the status is deleted, it deletes the respective campaign
Recurrence	Optional - The recurrence rule for the campaign
Escalation	Optional - The escalation time for the campaign. Accepted Values are 24h, 48h, 72h, 168h
Escalation Date	Optional - The escalation date from which the escalation time is calculated
Reviewer Precedence	Optional - In case of override, the default reviewer order. Accepted Values are `manager`, `primaryowner`, `riskmanager`. The value format is `{manager, riskmanager, primaryowner}`, default order can be changed
Reviewer Count	Optional - In case of override, Reviewers are assigned in the order set up in reviewer precedence and are expected to approve in sequence. Note: Take a min value of 1 and max of 3

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 Canonical 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 Campaigns CSV format.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
}

Bulk Campaigns Upload API (Early Access)

BalkanID Campaigns Upload CSV Format#

Column Definitions#

Upload the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Campaigns Upload CSV Format

Column Definitions

Upload the CSV file via the pre-signed URL