v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Promoters

Assign a parent promoter

With this endpoint you can assign a parent promoter to your promoters. <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/promoters/assign_parent</Tip>

post/promoters/assign_parent

Headers

Account-IDstring required

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

Request body

parent_promoter_idinteger required

The ID of the parent promoter you want to assign the promoters to

idsinteger[]

Array of promoter 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

Operation completed successfully

idinteger

Id of the batch operation

status'completed'

Status of the batch operation (always completed for synchronous operations)

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[]