PUT
/v1/admin/payout-tags/{tag}Rename or recolour one of the firm's payout tags. Every payout carrying it shows the new name at once.
Needs a firm. Our own staff name one with the Propper-Workspace header.
Request
Both fields, as in create.
curl -X PUT "https://api.proppertrading.com/v1/admin/payout-tags/ptag_6v572dpx4czzbab3" \
-H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
-H "Propper-Workspace: acme" \
-H "Content-Type: application/json" \
-d '{"name": "Escalated to Han", "color": "orange"}'
Response
{
"data": {
"object": "payout_tag",
"id": "ptag_6v572dpx4czzbab3",
"name": "Escalated to Han",
"color": "orange",
"count": 0
},
"meta": {
"request_id": "req_01m50qrkc9wybt4xt757a7cgqs"
}
}
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | workspace_required | Asked by our own staff without naming a firm |
| 401 | invalid_token | Not a token, or the secret does not match |
| 401 | revoked_token | Signed out here or from another device |
| 401 | expired_token | Ninety days without use, or a set expiry passed |
| 403 | admin_access_required | This account no longer helps run the environment |
| 403 | insufficient_scope | This device does not hold admin:write |
| 403 | workspace_not_permitted | The Propper-Workspace header names an environment this account cannot act in |
| 403 | forbidden | Without manage_payouts |
| 404 | resource_not_found | No payout tag with that id in this firm |
| 422 | validation_failed | No name, a name another tag has, or an unknown color |