Archive referral-agent link
POST/v1/partnership/referral-agent-links/:agent_link_id/archive
Archive an active referral-agent link. Archiving deactivates the associated rebate group. When an active reward-share agreement exists, it ends on the following day and is replaced with a zero-reward-share agreement.
Required scopes:
- write:
partnership.all.
Runtime restrictions:
- The referral-agent link must belong to the partner associated with the API key.
- Only a link with status
ACTIVEcan be archived.
Rules:
- Archiving deactivates the rebate group associated with the referral-agent link.
- A current reward-share agreement, when present, ends on the following day; a subsequent agreement has zero reward share.
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.
- An additional limit of 60 requests per 60 seconds applies to this operation. Both limits apply.
Consistency and recovery notes:
- The operation is not idempotent. After a timeout or connection failure, retrieve the link and confirm its status before retrying; a successfully archived link is no longer eligible for this operation.
Possible errors:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationErrorNotFound
Request
Responses
- 204
- 400
- 401
- 403
- 404
- 429
- 500
- 502
- 503
- 504
Referral-agent link archived successfully.
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.