Sign Up

Use the API for Advertiser and Partner User signups.

The Everflow platform offers a way for new Users to sign up in the UI. However, some organizations prefer hosting the signup page on their own website and submit the result to Everflow via the API.

The endpoints described here will help you achieve that.

The payloads submitted will mimic what a user would enter when using the signup form available on Everflow which is documented here.

New Users must have an email address that is unique among all users of the same “type” (Two Partner Users cannot have the same email address, but a Partner User can have the same email address as an Advertiser User).

Note that the content of the payload will be validated. For example, the address submitted must have a valid country, etc.

Custom signup fields (which are optional and defined in Control Center > Configuration > UI Customization), can be used to submit custom signup data on this endpoint. If they are marked as mandatory in Everflow, signups submitted via the API that do not contain the mandatory custom fields will result in an error.


Partner Signup

POST /v1/networks/affiliate/signup

If custom fields are used, their unique ID can be found by doing a GET on /v1/networks/settings/affiliateportal. The unique ID needed will be located in the relationship.custom_fields property of the response.

Signup links on Everflow can contain embedded information about:

  • The Partner Manager that will be responsible for the new Partner account
  • The Partner that referred New Partner

These values are encoded in the link. If used they must be submitted the same way in the payload as shown in the second example below. You can use the Encode / Decode endpoints to extract the numeric values if needed.

cURL
curl --request POST 'https://api.eflow.team/v1/networks/affiliate/signup' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
--data '<INSERT PAYLOAD>'

Request

A basic signup request would look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "legal_type": "individual",
    "company": "Example company",
    "website": "http://example-website.com",
    "advertise_method_description": "Facebook, Google Ads",
    "custom_terms": "<The custom terms and conditions the user agrees to>",
    "platform_terms": "<The platform terms and conditions the user agrees to>",
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    }
}

A more complete request could look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "legal_type": "individual",
    "company": "Example company",
    "website": "http://example-website.com",
    "advertise_method_description": "Facebook, Google Ads",
    "custom_terms": "<The custom terms and conditions the user agrees to>",
    "platform_terms": "<The platform terms and conditions the user agrees to",
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    },
    "referral_code": "facebook",
    "tax_id" : "...",
    "custom_field_values": [
        {
            "network_signup_custom_field_id": 2,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 11,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 16,
            "field_value": "my optional custom field value"
        },
    ],
    "affiliate_manager_encoded_value": "RNK3G2",
    "referrer_encoded_value": "RNK3G2",

}


Advertiser Signup

POST /v1/networks/advertiser/signup

If custom fields are used, their unique ID can be found by doing a GET on /v1/networks/settings/advertiserportal. The unique ID needed will be located in the relationship.custom_fields property of the response.

cURL
curl --request POST 'https://api.eflow.team/v1/networks/advertiser/signup' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
--data '<INSERT PAYLOAD>'

Request

A signup request could look like this:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-555-1212",
    "company": "Example company",
    "website": "http://example-website.com",
    "offer_landing_page": "example landing page",
    "custom_terms": "<The custom terms and conditions the user agrees to>",
    "platform_terms": "<The platform terms and conditions the user agrees to",
    "referral_code": "facebook",
    "is_agree_platform_term": true,
    "contact_address": {
        "address_1": "Address Line 1",
        "address_2": "Address Line 2",
        "city": "Example City",
        "zip_postal_code": "32789",
        "country_id": 227,
        "region_code": "FL"
    },
    "custom_field_values": [
        {
            "network_signup_custom_field_id": 2,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 11,
            "field_value": "my optional custom field value"
        },
        {
            "network_signup_custom_field_id": 16,
            "field_value": "my optional custom field value"
        },
    ]
}