Referrals

Move referrals to promoter

With this endpoint you can move referrals to another promoter. <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/>POST https://api.firstpromoter.com/api/v2/company/referrals/move_to_promoter</Tip>

post/referrals/move_to_promoter

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/move_to_promoter/post.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

promoter_campaign_idinteger required

Destination promoter campaign ID

move_associated_commissionstrue | false

Move associated commissions

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 successfully.

idinteger

status'completed'

totalinteger

selected_totalinteger

processed_countinteger

failed_countinteger

action_labelstring

created_atstring date-time

updated_atstring date-time

metaobject

progressinteger

processing_errorsstring[]

Changes

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