Delete referrals

curl --request DELETE \
  --url https://v2.firstpromoter.com/api/v2/company/referrals \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    123
  ]
}'

{
  "id": 123,
  "status": "pending",
  "total": 123,
  "selected_total": 123,
  "processed_count": 123,
  "failed_count": 123,
  "action_label": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "meta": {},
  "progress": 123,
  "processing_errors": [
    "<string>"
  ]
}

DELETE

referrals

Delete referrals

curl --request DELETE \
  --url https://v2.firstpromoter.com/api/v2/company/referrals \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    123
  ]
}'

{
  "id": 123,
  "status": "pending",
  "total": 123,
  "selected_total": 123,
  "processed_count": 123,
  "failed_count": 123,
  "action_label": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "meta": {},
  "progress": 123,
  "processing_errors": [
    "<string>"
  ]
}

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

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

API Documentation

Batch Processes

Tracking Api

Referrals

Promoters

Promoter Campaigns

Commissions

Promo Codes

Payouts

Reports

Delete referrals

Authorizations

Headers

Body

Response