Update rebate row destinations
PATCH/v1/partnership/autorebates/:rebate_id/clients
Choose another trading account of the same client to receive selected pending rebates instead of the default account. This choice also applies to future rebates earned on the original trading account. Identify one row with rebate_row_id or several with rebate_row_ids; rows in the same request must belong to the same client. The rows are changed one at a time. If one change fails, earlier rows may already have changed, so check each selected row 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:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationErrorNotFound
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 502
- 503
- 504
Rebate row destinations 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.
Requested resource was not found or is not visible to the authenticated partner.
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.