Skip to main content
POST
Submit Affiliate Signup
Submit an affiliate self-registration. This is the public endpoint used when affiliates sign up through the registration page. Creates a new affiliate account (pending approval) with the provided information. Which fields are required depends on your network’s partner signup configuration in Control Center. Fields such as firstname, lastname, company, and contact_address are only enforced when they are marked visible and required there. Custom fields (custom_field_values) are optional and defined in Control Center under the signup page configuration. Field IDs can be retrieved via GET /networks/settings/affiliateportal (in the relationship.custom_fields array). Fields marked as mandatory in the UI are also required in API submissions.

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Body

application/json
firstname
string
required

The first name of the affiliate user signing up.

lastname
string
required

The last name of the affiliate user signing up.

email
string
required

The email address of the user signing up. Must be unique.

company
string
required

The affiliate's company name. Will become the affiliate name once/if the affiliate is approved.

website
string
required

The affiliate's website.

advertise_method_description
string
required

Method used by the affiliate to advertise.

phone
string

Phone number.

The affiliate's entity legal type.

Available options:
individual,
partnership,
corporation,
sole_proprietorship,
other,
foreign,
llc,
llp,
non_profit,
non_us_entity
heard_about_us
string

How the affiliate heard about the network.

contact_address
object

Affiliate's mailing/contact address.

referral_code
string

Referral code used during signup.

tax_id
string

Tax identification number (EIN, SSN, etc.).

language_id
integer

The affiliate's portal language. Defaults to the network's language when omitted. Valid values can be found using the metadata API.

timezone_id
integer

The affiliate's timezone. Defaults to the network's timezone when omitted. Valid values can be found using the metadata API.

currency_id
string

The affiliate's currency (e.g. "USD"). Defaults to the network's currency when omitted. Valid values can be found using the metadata API.

advertiser_identifier
string

Binds the signup to an advertiser-specific signup form. When set, custom field values are matched against the advertiser-specific signup configuration instead of the network one.

affiliate_manager_encoded_value
string

Affiliate manager's encoded ID.

referrer_encoded_value
string

Encoded value of the affiliate ID that referred the new sign up.

partner_encoded_value
string

Encoded value of the partner that the sign up is associated with.

billing
object

The affiliate's billing information.

promotional_information
object[]

The affiliate's promotional methods and properties.

custom_field_values
object[]

Responses to custom signup fields defined in Control Center.

Response

200

Affiliate signup submitted successfully.