Delete a payout tag

.md

Remove a payout tag from the firm and from every payout carrying it.

Scopesadmin:write
Permissionmanage_payouts
DELETE/v1/admin/payout-tags/{tag}

Remove one of the firm's payout tags. It goes from every payout that carried it, and there is no undo.

Needs a firm. Our own staff name one with the Propper-Workspace header.

Request

curl -X DELETE "https://api.proppertrading.com/v1/admin/payout-tags/ptag_6v572dpx4czzbab3" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme"

Response

204, with no body.

Errors

StatusCodeMeaning
400workspace_requiredAsked by our own staff without naming a firm
401invalid_tokenNot a token, or the secret does not match
401revoked_tokenSigned out here or from another device
401expired_tokenNinety days without use, or a set expiry passed
403admin_access_requiredThis account no longer helps run the environment
403insufficient_scopeThis device does not hold admin:write
403workspace_not_permittedThe Propper-Workspace header names an environment this account cannot act in
403forbiddenWithout manage_payouts
404resource_not_foundNo payout tag with that id in this firm