Payouts
Change payouts status
This call allows you to change the status of the payout. For example, you can mark the payout as completed once it has been paid.
PUT
/
update
Copy
curl --request PUT \
--url https://firstpromoter.com/api/v1/payouts/update \
--header 'X-API-KEY: <api-key>'
Copy
{
"id": 2710287,
"status": "completed",
"amount": 3000,
"date_paid": null,
"due_date": "2024-10-11T00:00:00.000Z",
"unit": "cash",
"created_at": "2024-09-12T14:02:53.135Z",
"has_issues": false,
"reward": null,
"promoter": {
"id": 8262622,
"status": "active",
"cust_id": "",
"email": "[email protected]",
"created_at": "2024-05-27T17:43:38.935Z",
"temp_password": "xsKyiS",
"default_promotion_id": 9441115,
"pref": "w4wfj9q",
"default_ref_id": "testxeak1xz1",
"note": "This is a test promoter. You can use it to test the integration.",
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": null,
"earnings_balance": {
"cash": 23000
},
"current_balance": {
"cash": 23000
},
"paid_balance": null,
"auth_token": "bFahsKx8v9_zL9sPTZCDH8JnQAbTeDpy"
},
"campaign": {
"id": 15161,
"name": "Test new campaign",
"landing_url": "http://testmax.maxwelladapoe1.com/",
"description": "",
"private": false,
"color": "#00bcd4",
"default_webhook_url": "",
"auto_approve_rewards": true,
"auto_approve_promoters": true
}
}
Authorizations
Query Parameters
ID of payout inside FirstPromoter
The new payout status.
Available options:
pending
, processing
, completed
Response
200
application/json
Success response
The response is of type object
.
Copy
curl --request PUT \
--url https://firstpromoter.com/api/v1/payouts/update \
--header 'X-API-KEY: <api-key>'
Copy
{
"id": 2710287,
"status": "completed",
"amount": 3000,
"date_paid": null,
"due_date": "2024-10-11T00:00:00.000Z",
"unit": "cash",
"created_at": "2024-09-12T14:02:53.135Z",
"has_issues": false,
"reward": null,
"promoter": {
"id": 8262622,
"status": "active",
"cust_id": "",
"email": "[email protected]",
"created_at": "2024-05-27T17:43:38.935Z",
"temp_password": "xsKyiS",
"default_promotion_id": 9441115,
"pref": "w4wfj9q",
"default_ref_id": "testxeak1xz1",
"note": "This is a test promoter. You can use it to test the integration.",
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": null,
"earnings_balance": {
"cash": 23000
},
"current_balance": {
"cash": 23000
},
"paid_balance": null,
"auth_token": "bFahsKx8v9_zL9sPTZCDH8JnQAbTeDpy"
},
"campaign": {
"id": 15161,
"name": "Test new campaign",
"landing_url": "http://testmax.maxwelladapoe1.com/",
"description": "",
"private": false,
"color": "#00bcd4",
"default_webhook_url": "",
"auto_approve_rewards": true,
"auto_approve_promoters": true
}
}
Assistant
Responses are generated using AI and may contain mistakes.