Create custom partner code
POST/v1/partnership/partner/codes
Create a unique custom partner code that can be included in a partner link used for client acquisition, optionally bound to a partner account. The response returns the created partner link with that custom partner code.
Required scopes:
- write:
partnership.all.
Runtime restrictions:
- The partner must be permitted to create partner codes.
Rules:
- A partner can have up to 20 active custom partner codes.
partner_codemust contain 3 to 10 lowercase Latin letters, digits, underscores, or hyphens. A numeric-only code and a code beginning withc_are not allowed.- The code must be unique and must not contain terms prohibited by the service, including explicit language or Exness-related terms.
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:
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.