> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Create affiliate > Creates or finds an affiliate for a company and user. Required permissions: - `affiliate:create` ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml post /affiliates openapi: 3.1.0 info: title: Whop API description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ version: 1.0.0 servers: - url: https://api.whop.com/api/v1 description: Production Whop API security: [] tags: - name: Products description: Products - name: Plans description: Plans - name: Payments description: Payments - name: Refunds description: Refunds - name: Disputes description: Disputes - name: Dispute alerts description: Dispute alerts - name: Resolution center cases description: Resolution center cases - name: Checkout configurations description: Checkout configurations - name: Setup intents description: Setup intents - name: Payment methods description: Payment methods - name: Invoices description: Invoices - name: Promo codes description: Promo codes - name: Card transactions description: Card transactions - name: Ledger accounts description: Ledger accounts - name: Transfers description: Transfers - name: Withdrawals description: Withdrawals - name: Payout methods description: Payout methods - name: Verifications description: Verifications - name: Payout accounts description: Payout accounts - name: Topups description: Topups - name: Users description: Users - name: Companies description: Companies - name: Authorized users description: Authorized users - name: Fee markups description: Fee markups - name: Members description: Members - name: Memberships description: Memberships - name: Leads description: Leads - name: Entries description: Entries - name: Shipments description: Shipments - name: Reviews description: Reviews - name: Company token transactions description: Company token transactions - name: Affiliates description: Affiliates - name: Experiences description: Experiences - name: Forums description: Forums - name: Forum posts description: Forum posts - name: Chat channels description: Chat channels - name: Support channels description: Support channels - name: Messages description: Messages - name: Reactions description: Reactions - name: Dm members description: Dm members - name: Dm channels description: Dm channels - name: Notifications description: Notifications - name: Courses description: Courses - name: Course chapters description: Course chapters - name: Course lessons description: Course lessons - name: Course students description: Course students - name: Course lesson interactions description: Course lesson interactions - name: Apps description: Apps - name: Webhooks description: Webhooks - name: App builds description: App builds - name: Access tokens description: Access tokens - name: Account links description: Account links - name: Files description: Files - name: Ai chats description: Ai chats - name: Bounties description: Bounties - name: Stats description: Stats - name: Ad campaigns description: Ad campaigns - name: Ad groups description: Ad groups - name: Ads description: Ads - name: Conversions description: Conversions paths: /affiliates: post: tags: - Affiliates summary: Create affiliate description: |- Creates or finds an affiliate for a company and user. Required permissions: - `affiliate:create` operationId: createAffiliate parameters: [] requestBody: required: true content: application/json: schema: type: object properties: company_id: type: string description: The ID of the company to create the affiliate for. example: biz_xxxxxxxxxxxxxx user_identifier: type: string description: >- The user identifier (username, email, user ID, or Discord ID). required: - company_id - user_identifier description: Parameters for CreateAffiliateRecord responses: '200': description: A successful response content: application/json: schema: $ref: '#/components/schemas/Affiliate' '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: invalid_request_error code: parameter_missing message: 'Missing required parameter: amount.' param: amount '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: unauthorized message: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: forbidden message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: not_found message: Resource not found '422': description: Verification required content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: null '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: internal_server_error message: An unexpected error occurred security: - bearerAuth: - affiliate:create x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const affiliate = await client.affiliates.create({ company_id: 'biz_xxxxxxxxxxxxxx', user_identifier: 'user_identifier', }); console.log(affiliate.id); - lang: Python source: |- import os from whop_sdk import Whop client = Whop( api_key=os.environ.get("WHOP_API_KEY"), # This is the default and can be omitted ) affiliate = client.affiliates.create( company_id="biz_xxxxxxxxxxxxxx", user_identifier="user_identifier", ) print(affiliate.id) - lang: Ruby source: >- require "whop_sdk" whop = WhopSDK::Client.new(api_key: "My API Key") affiliate = whop.affiliates.create(company_id: "biz_xxxxxxxxxxxxxx", user_identifier: "user_identifier") puts(affiliate) components: schemas: Affiliate: type: object properties: id: type: string description: The unique identifier for the affiliate. example: aff_xxxxxxxxxxxxxx status: oneOf: - $ref: '#/components/schemas/Status' - type: 'null' description: The status of the affiliate created_at: type: string format: date-time description: The datetime the affiliate was created. example: '2023-12-01T05:00:00.401Z' updated_at: type: string format: date-time description: The datetime the affiliate was last updated. example: '2023-12-01T05:00:00.401Z' total_referrals_count: type: integer description: The total referrals of the affiliate example: 42 total_referral_earnings_usd: type: string description: >- The total commission earnings paid to this affiliate, formatted as a USD currency string total_overrides_count: type: integer description: The total count of all overrides for this affiliate example: 42 customer_retention_rate: type: string description: The percentage of referred customers who are still active members customer_retention_rate_ninety_days: type: string description: >- The percentage of referred customers who remained active over the last 90 days monthly_recurring_revenue_usd: type: string description: >- The monthly recurring revenue generated by this affiliate's referrals, formatted as a USD currency string total_revenue_usd: type: string description: >- The total revenue generated from this affiliate's referrals, formatted as a USD currency string active_members_count: type: integer description: The total active members of the affiliate example: 42 user: type: object properties: id: type: string description: The unique identifier for the user. example: user_xxxxxxxxxxxxx name: type: - string - 'null' description: >- The display name set on the user's Whop profile. Null if the user has not set a name. example: Jane Smith username: type: - string - 'null' description: >- The unique username chosen by the user for their Whop profile. Null if the user has not set a username. example: janesmith required: - id - name - username description: The user attached to this affiliate company: type: object properties: id: type: string description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx title: type: string description: The written name of the company. required: - id - title description: The company attached to this affiliate required: - id - status - created_at - updated_at - total_referrals_count - total_referral_earnings_usd - total_overrides_count - customer_retention_rate - customer_retention_rate_ninety_days - monthly_recurring_revenue_usd - total_revenue_usd - active_members_count - user - company description: >- An affiliate tracks a user's referral performance and commission earnings for a company, including retention rates, revenue metrics, and payout configurations. Status: type: string enum: - active - archived - deleted description: Statuses for resources securitySchemes: bearerAuth: type: http description: >- A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************` scheme: bearer bearerFormat: auth-scheme ````