Referrals

Delete referrals

With this endpoint you can delete referrals. <Note>If there are more than 5 ids on the ids 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</Note> <Tip>HTTP Request <br/>DELETE https://api.firstpromoter.com/api/v2/company/referrals</Tip>

delete/referrals

Request

Base URL
https://api.firstpromoter.com/api/v2/company
Auth
HTTP bearer
TypeScript
https://skmtc.dev/firstpromoter/apis/firstpromoter-batch-processes-api/docs/referrals/delete.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Account-IDstring required

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

Request body

idsinteger[]

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

idinteger

Id of the batch operation

status'pending' | 'completed'

Status of the batch operation

totalinteger

Total number of items

selected_totalinteger

Number of selected items

processed_countinteger

Number of processed items

failed_countinteger

Number of failed operations

action_labelstring

Action identifier/ label assigned to the action

created_atstring date-time

Date and time when the batch operation was created

updated_atstring date-time

Date and time when the batch operation was updated

metaobject

Meta data of the batch operation

progressinteger

Progress of the action (0-100)

processing_errorsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.