Skip to main content
DELETE
Delete referrals

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations → Manage API Keys

Headers

Account-ID
string
required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Body

application/json
ids
integer[]

Array of selected referral ids. If there are more than 5 ids on this param/field, the action will be processed asynchronously. The response for the batch status will most likely be in_progress. The available statuses are pending, in_progress, completed, failed and stopped

Response

Batch operation completed

id
integer

Id of the batch operation

status
enum<string>

Status of the batch operation

Available options:
pending,
completed
total
integer

Total number of items

selected_total
integer

Number of selected items

processed_count
integer

Number of processed items

failed_count
integer

Number of failed operations

action_label
string

Action identifier/ label assigned to the action

created_at
string<date-time>

Date and time when the batch operation was created

updated_at
string<date-time>

Date and time when the batch operation was updated

meta
object

Meta data of the batch operation

progress
integer

Progress of the action (0-100)

processing_errors
string[]

List of processing errors