Tag a payout

.md

Set the team's own labels on a payout request.

Scopesadmin:write
Permissionmanage_payouts
PUT/v1/admin/payouts/{payout}/tags

The team's own labels on a request: why it waits, who is on it. Send the whole list the request should carry, an empty one to take every tag off. Nothing else changes, not the status and not what the trader sees: traders never see tags.

The tags are the firm's payout tags.

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

Request

FieldDescription
tag_idsThe ids of every tag the request should carry, up to 100. Required, and may be empty
curl -X PUT "https://api.proppertrading.com/v1/admin/payouts/po_pk2jjt25cw5swbwv/tags" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme" \
  -H "Content-Type: application/json" \
  -d '{"tag_ids": ["ptag_yk5b6gy5wq9cp4k3", "ptag_mmsktt6kdyg5965a"]}'

Response

The payout, with its tags as they are now.

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 with that id in this firm
422validation_failedNo tag_ids, more than 100, or an id that is not one of this firm's tags