> ## Documentation Index > Fetch the complete documentation index at: https://dub.co/llms.txt > Use this file to discover all available pages before exploring further. # Create or update a partner > Creates a partner and enrolls them in the program. If that email is already enrolled, the enrollment is returned unchanged, except a different `tenantId` replaces the current one when it is not already associated with another partner in the program. ## OpenAPI ````yaml post /partners openapi: 3.0.3 info: title: Dub API description: >- Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs. version: 0.0.1 contact: name: Dub Support email: support@dub.co url: https://dub.co/support license: name: AGPL-3.0 license url: https://github.com/dubinc/dub/blob/main/LICENSE.md servers: - url: https://api.dub.co description: Production API security: [] paths: /partners: post: tags: - Partners summary: Create or update a partner description: >- Creates a partner and enrolls them in the program. If that email is already enrolled, the enrollment is returned unchanged, except a different `tenantId` replaces the current one when it is not already associated with another partner in the program. operationId: createPartner requestBody: content: application/json: schema: type: object properties: name: description: >- The partner's full name. If undefined, the partner's email will be used in lieu of their name (e.g. `john@acme.com`) nullable: true type: string maxLength: 100 email: type: string maxLength: 190 format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ description: >- The partner's email address. Partners will be able to claim their profile by signing up at `partners.dub.co` with this email. username: description: >- The partner's unique username in your system (max 100 characters). This will be used to create a short link for the partner using your program's default domain. If not provided, Dub will try to generate a username from the partner's name or email. nullable: true type: string maxLength: 100 image: description: >- The partner's avatar image. If not provided, a default avatar will be used. nullable: true type: string tenantId: description: >- The partner's unique ID in your system. Useful for retrieving the partner's links and stats later on. If not provided, the partner will be created as a standalone partner. type: string groupId: description: >- The group ID to add the partner to. If not provided, the partner will be added to the default group. type: string tagIds: description: >- The IDs of the partner tags to assign when creating the partner. Existing tags are kept. Takes priority over `tagNames` only when it contains at least one ID. maxItems: 100 type: array items: type: string tagNames: description: >- The names of the partner tags to assign when creating the partner. Existing tags are kept. Ignored only when `tagIds` contains at least one ID. maxItems: 100 type: array items: type: string country: description: >- The partner's country of residence. Must be passed as a 2-letter ISO 3166-1 country code. See https://d.to/geo for more information. nullable: true type: string description: description: >- A brief description of the partner and their background. Max 5,000 characters. nullable: true type: string maxLength: 5000 linkProps: description: >- Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. type: object properties: externalId: description: >- The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. Pass `null` or an empty string to remove it. example: '123456' nullable: true type: string maxLength: 255 tenantId: description: >- The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant. Pass `null` or an empty string to remove it. nullable: true type: string maxLength: 255 prefix: description: >- Path prefix for each default referral link slug (e.g. `/c/` → `https://{domain}/c/{identity}`). If the group has multiple default links, a short random suffix is appended to the identity segment for uniqueness (e.g. `c/jane-a7f2`). type: string archived: description: >- Whether the short link is archived. Defaults to `false` if not provided. type: boolean tagIds: description: The unique IDs of the tags assigned to the short link. example: - clux0rgak00011... anyOf: - type: string - type: array items: type: string tagNames: description: >- The unique name of the tags assigned to the short link (case insensitive). anyOf: - type: string - type: array items: type: string comments: nullable: true description: The comments for the short link. type: string expiresAt: description: The date and time when the short link will expire at. nullable: true type: string expiredUrl: description: The URL to redirect to when the short link has expired. maxLength: 32000 nullable: true type: string password: nullable: true description: >- The password required to access the destination URL of the short link. type: string proxy: description: >- Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided. type: boolean title: description: >- The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og nullable: true type: string description: description: >- The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og nullable: true type: string image: description: >- The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og nullable: true type: string video: nullable: true description: >- The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og type: string rewrite: description: >- Whether the short link uses link cloaking. Defaults to `false` if not provided. type: boolean ios: description: >- The iOS destination URL for the short link for iOS device targeting. nullable: true type: string maxLength: 32000 android: description: >- The Android destination URL for the short link for Android device targeting. nullable: true type: string maxLength: 32000 doIndex: description: >- Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex type: boolean testVariants: nullable: true minItems: 2 maxItems: 4 type: array items: type: object properties: url: type: string percentage: type: number minimum: 10 maximum: 90 required: - url - percentage description: >- An array of A/B test URLs and the percentage of traffic to send to each URL. example: - url: https://example.com/variant-1 percentage: 50 - url: https://example.com/variant-2 percentage: 50 testStartedAt: description: The date and time when the tests started. nullable: true type: string testCompletedAt: description: >- The date and time when the tests were or will be completed. nullable: true type: string required: - email responses: '201': description: The created or updated partner content: application/json: schema: type: object properties: id: type: string description: The partner's unique ID on Dub. name: type: string maxLength: 190 description: The partner's full legal name. username: nullable: true description: The partner's unique username on Dub. type: string email: nullable: true description: >- The partner's email address. Should be a unique value across Dub. type: string maxLength: 190 image: nullable: true description: The partner's avatar image. type: string description: description: A brief description of the partner and their background. nullable: true type: string maxLength: 5000 country: nullable: true description: The partner's country (required for tax purposes). type: string companyName: nullable: true description: >- If the partner profile type is a company, this is the partner's legal company name. type: string maxLength: 190 networkStatus: type: string enum: - draft - submitted - approved - rejected - trusted description: The partner's network status on Dub. defaultPayoutMethod: nullable: true description: >- The partner's default payout method. Connect: Bank account payouts via Stripe Connect; Stablecoin: USDC payouts directly to a crypto wallet; PayPal: Payouts via PayPal type: string enum: - connect - stablecoin - paypal - tremendous paypalEmail: nullable: true description: >- The partner's PayPal email (for receiving payouts via PayPal). type: string stripeConnectId: nullable: true description: >- The partner's Stripe Connect ID (for receiving payouts via Stripe). type: string payoutsEnabledAt: nullable: true description: The date when the partner enabled payouts. type: string identityVerifiedAt: nullable: true description: The date when the partner's identity was verified. type: string programId: type: string description: The program's unique ID on Dub. groupId: description: The partner's group ID on Dub. nullable: true type: string partnerId: type: string description: The partner's unique ID on Dub. tenantId: nullable: true description: >- The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future. type: string createdAt: type: string status: type: string enum: - pending - approved - rejected - invited - declined - deactivated - banned - archived description: The status of the partner's enrollment in the program. links: nullable: true description: The partner's referral links in this program. type: array items: type: object properties: id: type: string description: The unique ID of the short link. domain: type: string description: >- The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). key: type: string description: >- The short link slug. If not provided, a random 7-character slug will be generated. shortLink: type: string format: uri description: >- The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`). url: type: string description: The destination URL of the short link. clicks: default: 0 description: The number of clicks on the short link. type: number leads: default: 0 description: The number of leads the short link has generated. type: number conversions: default: 0 description: >- The number of leads that converted to paying customers. type: number sales: default: 0 description: >- The total number of sales (includes recurring sales) generated by the short link. type: number saleAmount: description: >- The total dollar value of sales (in cents) generated by the short link. default: 0 type: number required: - id - domain - key - shortLink - url - clicks - leads - conversions - sales - saleAmount additionalProperties: false totalCommissions: description: >- The total commissions paid to the partner for their referrals default: 0 type: number clickRewardId: nullable: true type: string leadRewardId: nullable: true type: string saleRewardId: nullable: true type: string referralRewardId: nullable: true type: string customRewardId: nullable: true type: string discountId: nullable: true type: string applicationId: description: >- If the partner submitted an application to join the program, this is the ID of the application. nullable: true type: string bannedAt: description: >- If the partner was banned from the program, this is the date of the ban. nullable: true type: string bannedReason: description: >- If the partner was banned from the program, this is the reason for the ban. nullable: true type: string enum: - tos_violation - inappropriate_content - fake_traffic - fraud - spam - brand_abuse application: description: >- Linked program application, including review outcome when applicable. nullable: true type: object properties: rejectionReason: nullable: true description: Preset reason when the application was rejected. type: string enum: - needsMoreDetail - doesNotMeetRequirements - notTheRightFit - other rejectionNote: nullable: true description: Free-form note when the application was rejected. type: string reviewedAt: nullable: true description: When the application was approved or rejected. type: string required: - rejectionReason - rejectionNote - reviewedAt additionalProperties: false tags: description: The tags associated with the partner. type: array items: type: object properties: id: type: string name: type: string required: - id - name additionalProperties: false totalClicks: default: 0 description: The total number of clicks on the partner's links type: number totalLeads: default: 0 description: The total number of leads generated by the partner's links type: number totalConversions: default: 0 description: >- The total number of leads that converted to paying customers type: number totalSales: default: 0 description: >- The total number of sales generated by the partner's links (includes recurring sales) type: number totalSaleAmount: description: Total revenue generated by the partner's links default: 0 type: number netRevenue: description: >- Net revenue after commissions (`Total Revenue - Total Commissions`) default: 0 type: number earningsPerClick: description: Earnings Per Click (EPC) (`Total Revenue ÷ Total Clicks`) nullable: true type: number averageLifetimeValue: description: >- Average lifetime value for each paying customer (`Total Revenue ÷ Total Conversions`) nullable: true type: number clickToLeadRate: description: >- Percentage of clicks that become leads (`Total Leads ÷ Total Clicks`) nullable: true type: number clickToConversionRate: description: >- Percentage of clicks that convert to paying customers (`Total Conversions ÷ Total Clicks`) nullable: true type: number leadToConversionRate: description: >- Percentage of leads that convert to paying customers (`Total Conversions ÷ Total Leads`) nullable: true type: number returnOnAdSpend: description: >- Return On Ad Spend (ROAS) (`Total Revenue ÷ Total Commissions`) nullable: true type: number website: description: The partner's website URL (including the https protocol). nullable: true type: string youtube: description: The partner's YouTube channel username (e.g. `johndoe`). nullable: true type: string twitter: description: The partner's Twitter username (e.g. `johndoe`). nullable: true type: string linkedin: description: The partner's LinkedIn username (e.g. `johndoe`). nullable: true type: string instagram: description: The partner's Instagram username (e.g. `johndoe`). nullable: true type: string tiktok: description: The partner's TikTok username (e.g. `johndoe`). nullable: true type: string trustedAt: deprecated: true description: 'DEPRECATED: Use `networkStatus` instead.' nullable: true type: string required: - id - name - username - email - image - country - companyName - networkStatus - defaultPayoutMethod - paypalEmail - stripeConnectId - payoutsEnabledAt - identityVerifiedAt - programId - partnerId - tenantId - createdAt - status - links - totalCommissions - totalClicks - totalLeads - totalConversions - totalSales - totalSaleAmount - netRevenue additionalProperties: false '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' security: - token: [] components: responses: '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). content: application/json: schema: x-speakeasy-name-override: BadRequest type: object properties: error: type: object properties: code: type: string enum: - bad_request description: A short code indicating the error code returned. example: bad_request message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#bad-request required: - code - message required: - error '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. content: application/json: schema: x-speakeasy-name-override: Unauthorized type: object properties: error: type: object properties: code: type: string enum: - unauthorized description: A short code indicating the error code returned. example: unauthorized message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#unauthorized required: - code - message required: - error '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. content: application/json: schema: x-speakeasy-name-override: Forbidden type: object properties: error: type: object properties: code: type: string enum: - forbidden description: A short code indicating the error code returned. example: forbidden message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#forbidden required: - code - message required: - error '404': description: The server cannot find the requested resource. content: application/json: schema: x-speakeasy-name-override: NotFound type: object properties: error: type: object properties: code: type: string enum: - not_found description: A short code indicating the error code returned. example: not_found message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#not-found required: - code - message required: - error '409': description: >- This response is sent when a request conflicts with the current state of the server. content: application/json: schema: x-speakeasy-name-override: Conflict type: object properties: error: type: object properties: code: type: string enum: - conflict description: A short code indicating the error code returned. example: conflict message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#conflict required: - code - message required: - error '410': description: >- This response is sent when the requested content has been permanently deleted from server, with no forwarding address. content: application/json: schema: x-speakeasy-name-override: InviteExpired type: object properties: error: type: object properties: code: type: string enum: - invite_expired description: A short code indicating the error code returned. example: invite_expired message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://dub.co/docs/api-reference/errors#invite-expired required: - code - message required: - error '422': description: >- The request was well-formed but was unable to be followed due to semantic errors. content: application/json: schema: x-speakeasy-name-override: UnprocessableEntity type: object properties: error: type: object properties: code: type: string enum: - unprocessable_entity description: A short code indicating the error code returned. example: unprocessable_entity message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#unprocessable-entity required: - code - message required: - error '429': description: >- The user has sent too many requests in a given amount of time ("rate limiting") content: application/json: schema: x-speakeasy-name-override: RateLimitExceeded type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded description: A short code indicating the error code returned. example: rate_limit_exceeded message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#rate-limit_exceeded required: - code - message required: - error '500': description: The server has encountered a situation it does not know how to handle. content: application/json: schema: x-speakeasy-name-override: InternalServerError type: object properties: error: type: object properties: code: type: string enum: - internal_server_error description: A short code indicating the error code returned. example: internal_server_error message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://dub.co/docs/api-reference/errors#internal-server_error required: - code - message required: - error securitySchemes: token: type: http description: Default authentication mechanism scheme: bearer x-speakeasy-example: DUB_API_KEY ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.