> ## Documentation Index > Fetch the complete documentation index at: https://developers.everflow.io/llms.txt > Use this file to discover all available pages before exploring further. # Create Affiliate Create a new affiliate account. You can also include users, contact address, and labels in the same request. When `is_contact_address_enabled` is true, provide the `contact_address` object. When adding an affiliate, you can also add a user — that part uses the same fields as the Create Affiliate User endpoint. ## OpenAPI ````yaml openapi/affiliates.yaml post /networks/affiliates openapi: 3.0.3 info: title: Everflow Network API - Affiliates description: > Affiliate management endpoints for the Everflow partner marketing platform. Search, retrieve, create, and update affiliate accounts. To learn more about partners, see the [Partner overview](https://helpdesk.everflow.io/customer/who-is-a-partner-in-everflow). version: 1.0.0 servers: - description: Production Server url: https://api.eflow.team/v1 security: [] tags: - name: Affiliates description: Endpoints for searching and managing affiliates. paths: /networks/affiliates: post: tags: - Affiliates summary: Create Affiliate parameters: - in: query name: notification schema: type: boolean default: true description: >- Whether to send a welcome notification email to the affiliate. Defaults to `true` when omitted. requestBody: required: true content: application/json: examples: minimal: summary: Minimal required fields value: name: DocTest Affiliate account_status: active network_employee_id: 2 default_currency_id: USD billing: billing_frequency: monthly payment_type: none details: day_of_month: 1 billing: {} full: summary: Full example with user, address, and labels value: name: Premium Media Agency account_status: active network_employee_id: 2 internal_notes: Top performing partner default_currency_id: USD enable_media_cost_tracking_links: true is_contact_address_enabled: true network_affiliate_tier_id: 1 contact_address: address_1: 123 Main St address_2: Suite 100 city: New York region_code: NY country_code: US zip_postal_code: '10001' labels: - media-buyer - premium users: - first_name: Jane last_name: Doe email: jane.doe@example.com account_status: active language_id: 1 timezone_id: 90 currency_id: USD work_phone: '5551234567' billing: billing_frequency: monthly payment_type: paypal tax_id: 123-45-6789 is_invoice_creation_auto: false default_invoice_is_hidden: false default_payment_terms: 30 details: day_of_month: 1 billing: paypal_reception_method: email reception_identifier: payments@example.com schema: type: object required: - name - account_status - network_employee_id - default_currency_id - billing properties: name: type: string description: The name of the affiliate. account_status: type: string enum: - active - inactive description: The affiliate's account status. network_employee_id: type: integer description: The employee ID of the affiliate's account manager. internal_notes: type: string description: Internal notes for network usage. default_currency_id: type: string description: > The affiliate's default currency. Can be found using the [metadata API](/api-reference/get-metacurrencies). enable_media_cost_tracking_links: type: boolean description: >- Whether or not you want to allow the affiliate to pass and override cost in their tracking links. Defaults to `false`. referrer_id: type: integer description: >- The ID of the affiliate that referred the new affiliate. Defaults to `0` (none). is_contact_address_enabled: type: boolean description: >- Whether or not you want to include a contact address for this affiliate. Defaults to `false`. network_affiliate_tier_id: type: integer description: The ID of the Affiliate Tier. contact_address: type: object description: > The affiliate's contact address information. Only required if `is_contact_address_enabled` is set to `true`. properties: address_1: type: string description: Street address line 1. address_2: type: string description: Apartment / suite. city: type: string description: City name. region_code: type: string description: State or region code (e.g. "CA"). country_code: type: string description: Two-letter country code (e.g. "US"). zip_postal_code: type: string description: ZIP or postal code. labels: type: array items: type: string description: A label string. description: Used to associate labels to the affiliate. users: type: array description: > One or more user accounts to create for this affiliate. Uses the same fields as the Create Affiliate User endpoint. items: type: object description: An initial affiliate user to create. required: - first_name - last_name - email - language_id - timezone_id - currency_id - account_status properties: first_name: type: string description: The affiliate user's first name. last_name: type: string description: The affiliate user's last name. email: type: string description: >- The affiliate user's email. Must be unique among all affiliate users. Is used to log in the platform. language_id: type: integer description: >- The affiliate user's language ID. This is limited to the value `1` (English). timezone_id: type: integer description: > The affiliate user's timezone ID. Can be found using the [metadata API](/api-reference/get-metatimezones). title: type: string description: The affiliate user's title. work_phone: type: string description: The affiliate user's work phone number. cell_phone: type: string description: The affiliate user's cell phone number. instant_messaging_id: type: integer description: > The ID of an instant messaging platform. Allows you to save their identifier for further reference. `0` = None, `1` = Skype, `2` = Yahoo Messenger, `3` = Telegram, `4` = WhatsApp, `5` = Other. instant_messaging_identifier: type: string description: >- The affiliate user's instant messaging identifier, if `instant_messaging_id` was different than `0`. currency_id: type: string description: > The affiliate user's currency ID. Can be found using the [metadata API](/api-reference/get-metacurrencies). account_status: type: string enum: - active - inactive description: >- The affiliate user's account status. Can be either `active` or `inactive`. initial_password: type: string description: > The affiliate user's login password. If left empty, the affiliate will be sent an email asking to set their password. If supplied, the password must have a length of at least 12 characters. billing: type: object description: The affiliate's billing information. required: - billing_frequency - payment_type - details - billing properties: billing_frequency: type: string enum: - weekly - bimonthly - monthly - two_months - quarterly - manual - other description: The affiliate's invoicing frequency. payment_type: type: string enum: - none - pay - paypal - check - wire - direct_deposit - tipalti - paxum - veem - payoneer - bitcoin - webmoney - capitalist - transferwise - gift_card - masspay - skrill description: > The affiliate's payment type. `pay` refers to Everflow Pay. tax_id: type: string description: The affiliate's tax ID. is_invoice_creation_auto: type: boolean description: >- Configures automatic invoice creation for the affiliate. Defaults to `false`. auto_invoice_start_date: type: string description: > Configures automatic invoice creation start date. Dates are formatted `YYYY-mm-dd`. Required if `is_invoice_creation_auto` is set to `true`. default_invoice_is_hidden: type: boolean description: >- Configures whether invoices are hidden from the affiliate by default. Defaults to `false`. invoice_generation_days_delay: type: integer description: > Configures how many days to wait for invoice generation after the specified billing period. Defaults to `0`. invoice_amount_threshold: type: number format: double description: > Configures the minimal amount required for an invoice to be generated. Sums below the threshold are rolled over to the next billing period. Defaults to `0`, which is none. default_payment_terms: type: integer description: > Configures the number of days that will be used as the payment term on generated invoices. Defaults to `0`. details: type: object description: > The affiliate's billing frequency details. Required when `billing_frequency` is set to anything other than `manual` or `other`, or when `payment_type` is not `none` (an empty object is required). properties: day_of_week: type: integer description: > Specifies the day of the week, starting on Sunday (0=Sunday .. 6=Saturday). Required when `billing_frequency` is set to `weekly`. day_of_month_one: type: integer description: >- Specifies first day of the month. Required when `billing_frequency` is set to `bimonthly`. day_of_month_two: type: integer description: >- Specifies second day of the month. Required when `billing_frequency` is set to `bimonthly`. day_of_month: type: integer description: > Specifies day of the month. Required when `billing_frequency` is set to `monthly`, `two_months` or `quarterly`. starting_month: type: integer description: > Specifies the month from which the cycle is set to begin. Required when `billing_frequency` is set to `two_months` or `quarterly`. billing: type: object description: > The affiliate's payment method details. When `payment_type` is set to `none`, an empty object (`{}`) should be applied. properties: paxum_id: type: string description: >- The affiliate's Paxum ID. Required when `payment_type` is `paxum`. paypal_reception_method: type: string enum: - email - phone - paypal_account description: >- The reception method used with PayPal. Required when `payment_type` is `paypal`. reception_identifier: type: string description: >- The affiliate's PayPal reception identifier. Required when `payment_type` is `paypal`. email: type: string description: >- The affiliate's email. Required when `payment_type` is `payoneer` or `veem`. is_existing_payee: type: boolean description: >- Whether to assign an existing payee ID. Required when `payment_type` is `tipalti`. idap: type: string description: >- The payee's IDAP (Payee ID). Required when `payment_type` is `tipalti` and `is_existing_payee` is `true`. first_name: type: string description: >- The affiliate's first name. Required when `payment_type` is `veem`. last_name: type: string description: >- The affiliate's last name. Required when `payment_type` is `veem`. phone: type: string description: >- The affiliate's phone number (international format). Required when `payment_type` is `veem`. country_iso: type: string description: >- The affiliate's country ISO code. Required when `payment_type` is `veem`. bank_name: type: string description: >- The affiliate's bank name. Required when `payment_type` is `wire` or `direct_deposit`. bank_address: type: string description: >- The affiliate's bank address. Required when `payment_type` is `wire` or `direct_deposit`. account_name: type: string description: >- The affiliate's bank account name. Required when `payment_type` is `wire` or `direct_deposit`. account_number: type: string description: >- The affiliate's bank account number. Required when `payment_type` is `wire` or `direct_deposit`. routing_number: type: string description: >- The affiliate's bank routing number. Required when `payment_type` is `wire` or `direct_deposit`. swift_code: type: string description: >- The affiliate's SWIFT code. Required when `payment_type` is `wire` or `direct_deposit`. responses: '200': description: Affiliate created successfully. content: application/json: example: network_affiliate_id: 36 network_id: 1 name: DocTest Affiliate account_status: active network_employee_id: 2 internal_notes: '' has_notifications: true network_traffic_source_id: 0 account_executive_id: 0 adress_id: 0 default_currency_id: USD is_contact_address_enabled: false enable_media_cost_tracking_links: false time_created: 1774701138 time_saved: 1774701138 relationship: labels: total: 0 entries: [] users: total: 0 entries: [] account_manager: first_name: John last_name: Doe email: john.doe@example.com work_phone: '9781243585' cell_phone: '' instant_messaging_id: 0 instant_messaging_identifier: '' encoded_value: 2LQC3F network_affiliate_tier_id: 1 ios_app_sources: total: 0 entries: [] referrer_id: 0 schema: $ref: '#/components/schemas/Affiliate' security: - API Key: [] components: schemas: Affiliate: type: object description: An affiliate (partner) account in the network. properties: network_affiliate_id: type: integer description: Unique affiliate ID. network_id: type: integer description: Network ID. name: type: string description: Affiliate name. account_status: type: string enum: - active - inactive - pending - suspended description: Current account status. network_employee_id: type: integer description: Account manager employee ID. internal_notes: type: string description: Internal notes about this affiliate (not visible to the affiliate). default_currency_id: type: string description: Default currency code (e.g. USD). enable_media_cost_tracking_links: type: boolean description: Whether media cost tracking links are enabled for this affiliate. is_contact_address_enabled: type: boolean description: Whether the contact address is enabled. network_affiliate_tier_id: type: integer writeOnly: true description: >- The affiliate tier ID this affiliate belongs to. Only used in create/update requests. has_notifications: type: boolean description: Whether notifications are enabled. network_traffic_source_id: type: integer description: Associated traffic source ID. account_executive_id: type: integer description: Account executive employee ID. adress_id: type: integer description: >- Address record ID. Note the field name uses a single 'd' (`adress_id`) in the API response. address_id: type: integer description: Address record ID (alias). referrer_id: type: integer description: ID of the referring affiliate, if any. contact_address: type: object writeOnly: true description: Contact address. Only used in create/update requests. properties: address_1: type: string description: Street address line 1. address_2: type: string description: Apartment / suite. city: type: string description: City name. region_code: type: string description: State or region code (e.g. "CA"). country_code: type: string description: Two-letter country code (e.g. "US"). zip_postal_code: type: string description: ZIP or postal code. labels: type: array writeOnly: true description: >- Labels to assign. Only used in create/update requests. Use the relationship object to read labels. items: type: string description: A label string. time_created: type: integer example: 1734455015 description: Unix timestamp when the affiliate was created. time_saved: type: integer example: 1734455015 description: Unix timestamp when the affiliate was last updated. relationship: type: object description: Related data (only present when requested via query parameter). properties: labels: type: object description: Labels associated with this affiliate. properties: total: type: integer description: Total number of labels. entries: type: array description: List of label strings. items: type: string description: A label string. account_manager: type: object description: Account manager details. properties: first_name: type: string description: Account manager's first name. last_name: type: string description: Account manager's last name. email: type: string description: Account manager's email address. work_phone: type: string description: Account manager's work phone number. cell_phone: type: string description: Account manager's cell phone number. instant_messaging_id: type: integer description: Account manager's instant messaging platform ID. instant_messaging_identifier: type: string description: Account manager's instant messaging identifier. encoded_value: type: string description: Encoded tracking value. ios_app_sources: type: object description: iOS app sources associated with this affiliate. properties: total: type: integer description: Total number of iOS app sources. entries: type: array description: List of iOS app source records. items: type: object description: An iOS app source record. users: type: object description: User accounts associated with this affiliate. properties: total: type: integer description: Total number of users. entries: type: array description: List of user records. items: type: object description: An affiliate user record. overrides: type: object description: > Per-affiliate visibility overrides for advertiser variables. Controls which of `adv1`–`adv10` and `sale_amount` are visible to this partner, on a per-variable basis. properties: total: type: integer description: Total number of override entries. entries: type: array description: List of variable visibility overrides. items: type: object properties: is_visible: type: boolean description: Whether this variable is visible to the partner. variable: type: string enum: - adv1 - adv2 - adv3 - adv4 - adv5 - adv6 - adv7 - adv8 - adv9 - adv10 - sale_amount description: The advertiser variable being controlled. securitySchemes: API Key: description: The Everflow API key generated from the Control Center > Security. in: header name: X-Eflow-Api-Key type: apiKey ````