Add referral agent
POST/v1/partnership/referral-agent-links
Set up a referral agent for the person identified by email by creating a dedicated master-partner-owned link and assigning a partner-visible alias. The referral agent must satisfy the service eligibility checks; the response returns the new link and the agent's current commercial configuration.
Required scopes:
- write:
partnership.all.
Runtime restrictions:
emailmust identify an existing registered user who has completed the required KYC.- The referral agent cannot be the same person as the partner creating the link.
aliasmust be unique within the partner's referral-agent links.
Rules:
aliasmust not exceed 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.
- An additional limit of 5 requests per 60 seconds applies to this operation. Both limits apply.
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:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationError
Request
Responses
- 200
- 400
- 401
- 403
- 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.
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.