POST
/
promoters
/
restore
Restore promoters
curl --request POST \
  --url https://v2.firstpromoter.com/api/v2/company/promoters/restore \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ids": [
    123
  ]
}'
{
  "id": 123,
  "status": "completed",
  "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 section → 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 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

​
id
integer

Batch ID

​
status
enum<string>

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

Available options:
completed
​
total
integer

Total number of promoters

​
selected_total
integer

Total number of selected promoters

​
processed_count
integer

Number of processed promoters

​
failed_count
integer

Number of failed promoters

​
action_label
string

Label for the action

​
created_at
string<date-time>

Creation date of the batch operation

​
updated_at
string<date-time>

Last update date of the batch operation

​
meta
object

Additional metadata

​
progress
integer

Progress of the batch operation

​
processing_errors
string[]

List of processing errors if any