Set rebate percentage for client accounts
PATCH/v1/partnership/autorebates/clients
Apply the same rebate percentage to multiple client trading accounts. This removes each account from its rebate group. Check the updated rebate settings and group membership afterward.
Required scopes:
- write:
partnership.all.
Rate limits:
- This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.
Consistency and recovery notes:
- This API does not guarantee idempotent writes. If the response is lost, read the affected group, rule, client settings, or rebate rows before deciding whether to send the write again.
Possible errors:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationError
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 500
- 502
- 503
- 504
Client settings updated.
Bad request or validation error. The response uses either the numeric request-processing error response or the Partnership string-code error response.
Authentication failed. Authentication processing errors use numeric codes; a Partnership operation authentication error uses a string code.
Operation is not permitted for the authenticated API key, partner, or operation scope.
Rate limit exceeded.
Response Headers
Seconds to wait before retrying when the API provides a throttle wait time.
The API or a service required by the operation could not complete the request.
The API could not complete the request to the Partnership service.
A required service is temporarily unavailable or the request deadline was exceeded.
A service required by the Partnership operation could not be reached or timed out.