Switch automatic withdrawal on or off for up to 50 teams

Switch automatic bank withdrawal on (enabled: true) or off (enabled: false) for up to 50 teams in one call, the bulk form of autoWithdraw on PATCH /teams/{id}. Page through larger lists in several requests.

Partial success: each team is changed on its own and gets one entry in results, in request order, so a batch with mixed results still returns 200. Check result for each team: for example no-bank-account means the team was switched on but is not paid until it adds a bank account, and ineligible comes with a reason.

Safe to repeat: a team that is already on keeps its next withdrawal date (already-on), and a team that is already off is left alone (already-off).

Scope: if any id does not exist or belongs to a team outside your operator's scope, the whole request is refused with 403 TEAMS_NOT_IN_OPERATOR_SCOPE and context.teamIds lists those ids. Nothing is changed in that case.

A call can take up to about 30 seconds for 50 teams. Run these calls one after another: requests over the per-consumer concurrency cap get 429 CONCURRENCY_LIMIT_EXCEEDED.

Required scope: teams:write
Organization authorization: supported

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
teamIds
array of int64s
required
length between 1 and 50

Ids of the teams to switch automatic withdrawal on or off for: between 1 and 50 distinct, positive ids. Page through larger lists in several requests.

teamIds*
boolean
required

true switches automatic withdrawal on for every listed team, false switches it off.

Responses

400

The request is invalid: teamIds is empty, has more than 50 ids, has duplicates or a non-positive id, or enabled is missing. Nothing is changed.

422

The server refused the request as invalid. Nothing is changed.

429

Too many bulk auto-withdrawal requests in flight for this consumer (errorCode CONCURRENCY_LIMIT_EXCEEDED)

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json