Create Custom Fields for Affiliates

Sections

Changelog
Changelog

Theme switcher

LeadDyno API

This section allows users to track web traffic and effectively manage their affiliate program. By utilizing this API, users can gain valuable insights into their website traffic and enhance their affiliate marketing strategies.

Just getting started?

Check out our guide

Base URL

Production:

https://api.leaddyno.com/v1/

Language Box

Affiliates

This section allows users to manage and track affiliate relationships within their program. By utilizing this section, users can view, add, update, and remove affiliates, as well as access performance metrics and commission details. This section provides essential functionality for effectively managing affiliate partnerships and tracking the success of their referral activities.

Purchases

The Purchases section of the LeadDyno REST API allows users to retrieve detailed information about purchases made through the platform. With this functionality, users can track and manage customer transactions, gain insights into purchase patterns, and analyze sales data for informed decision-making.

Commissions

This section allows users to retrieve detailed information about the commissions earned through their affiliate marketing program. With this functionality, users can track and manage the financial aspects of their affiliate relationships, providing insight into earnings and performance metrics.

Leads

This section allows users to manage information related to potential leads or customers. Users can retrieve details about leads, update lead information, and track the status of leads within their LeadDyno account. This functionality provides essential tools for businesses looking to effectively manage and nurture their leads.

Visitors

This section allows users to manage and retrieve data related to website visitors, whether they were referred by affiliates or arrived organically. You can use these endpoints to track the journey and behavior of visitors across your website, helping to analyze performance and conversions.

Campaigns

This section allows users to manage and track their marketing campaigns efficiently. With this functionality, users can create, monitor, and analyze the performance of their campaigns to optimize their marketing efforts and drive better results.

Custom Fields

The Custom Fields section allows users to define and manage custom fields within the LeadDyno. By utilizing this section, users can customize their data structures and collect specific information tailored to their business needs. This section empowers users to enhance the flexibility and functionality of their LeadDyno integration.

Was this section helpful?

What made this section unhelpful for you?

Create Custom Fields for Affiliates

This section allows users to create custom fields for affiliates using the LeadDyno REST API. By leveraging this functionality, users can define and manage custom fields, determine if they are required, and associate them with specific affiliate groups, providing greater flexibility and organization within the LeadDyno platform.

Query Parameters

keystring Required

Your private key

Body Parameters

new_fieldstring Required

The name of the new custom field. Allowed characters include letters, numbers, spaces, and the symbols: ,.:#&?

is_requiredboolean

Specifies if the custom field is required. Defaults to false.

affiliate_group_idinteger (int32)

The ID of the affiliate group (compensation tier) associated with the custom field. If not provided, defaults to the affiliate website settings.

Response

201
Object
Creates a custom field.
Was this section helpful?

What made this section unhelpful for you?

POST

/custom_fields?key=YOUR_PRIVATE_KEY

Select
1 2 3 4 5 6 curl --location 'https://api.leaddyno.com/v1/custom_fields?key=YOUR_PRIVATE_KEY' \ --data '{ "new_field": "", "is_required": false, "affiliate_group_id": null }'

Response

true
Was this section helpful?

What made this section unhelpful for you?

Delete custom fields

This endpoint allows users to delete a specific custom field associated with an affiliate group in LeadDyno.

Query Parameters

keystring Required

Your private key

field_namestring Required

The name of the custom field to be removed.

affiliate_group_idinteger (int32)

The ID of the affiliate group (compensation tier) from which the custom field will be removed. If not provided, the default affiliate website settings will be used.

Response

200
Object
Removes a custom field.
Was this section helpful?

What made this section unhelpful for you?

DELETE

/custom_fields?key=YOUR_PRIVATE_KEY&field_name=&affiliate_group_id=

Select
1 curl --location --request DELETE 'https://api.leaddyno.com/v1/custom_fields?key=YOUR_PRIVATE_KEY&field_name='

Response

true
Was this section helpful?

What made this section unhelpful for you?

Retrieve custom fields

This section allows users to retrieve custom fields.

Query Parameters

keystring Required

Your private key

requiredboolean

If set to true, only the required custom fields will be returned. If set to false or not provided, all custom fields, whether required or not, will be returned. Defaults to false.

affiliate_group_idinteger (int32)

The ID of the affiliate group (compensation tier) to filter custom fields. If not provided, the default affiliate website settings will be used.

Response

200
Object
Get custom fields for the current user.

Response Attributes

Favorite Colorstring
Agestring
Was this section helpful?

What made this section unhelpful for you?

GET

/custom_fields?key=YOUR_PRIVATE_KEY&required=&affiliate_group_id=123

Select
1 curl --location 'https://api.leaddyno.com/v1/custom_fields?key=YOUR_PRIVATE_KEY&affiliate_group_id=123' \

Response

[
  "Favorite Color",
  "Age"
]
Was this section helpful?

What made this section unhelpful for you?

Sub IDs

This section allows users to retrieve detailed information about the affiliate links, Sub IDS.