Rename referral-agent link
PATCH/v1/partnership/referral-agent-links/:agent_link_id
Rename a referral-agent link. This operation changes only the alias and returns the link identifier with the saved alias; it does not change reward-share terms or shared-report configuration.
Required scopes:
- write:
partnership.all.
Runtime restrictions:
- The referral-agent link must belong to the partner associated with the API key.
- The link can be renamed when its status is
ACTIVE,ARCHIVED, orCOMMISSION_RESTRICTED. - The new alias must be unique within the partner's referral-agent links.
Rules:
aliasmust contain 1 to 50 characters.
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:
- The current Partnership API does not provide idempotent-write semantics. After a timeout or connection failure, read the affected resource or list before deciding whether to retry.
Possible errors:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationErrorNotFound
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
- 502
- 503
- 504
Successful response.
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.