LeadDyno REST API Documentation

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

Production:

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

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.

This section allows users to create a new affiliate within the LeadDyno system. Users can input details such as email, name, custom code, PayPal information, and referral affiliations.

Query Parameters

keystring Required

Your private key

Body Parameters

emailstring Required

The email address of the new affiliate.

first_namestring

The first name of the affiliate.

last_namestring

The last name of the affiliate.

affiliate_codestring

A custom affiliate code for the new affiliate.

paypal_emailstring

The PayPal email address for affiliate payouts.

unsubscribedboolean

Indicates whether the affiliate is unsubscribed from communications.

affiliate_typestring

The code for the affiliate's group.

override_approvalboolean

If set to true, the affiliate will not require approval.

referring_affiliatestring

The email of the affiliate who referred the new affiliate (MLM).

Response

201

Object

Creates a new affiliate. The affiliate can include custom fields, compensation tiers, and optionally be linked to a referring affiliate (MLM).

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

Show child attributes

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location 'https://api.leaddyno.com/v1/affiliates?key=YOUR_PRIVATE_KEY' \
--data '{
  "email": "",
  "first_name": "",
  "last_name": "",
  "affiliate_code": "",
  "paypal_email": "",
  "unsubscribed": false,
  "affiliate_type": "",
  "override_approval": false,
  "referring_affiliate": ""
}'

{
  "id": 17175,
  "email": "affiliate@email.com",
  "first_name": "Johnny",
  "last_name": "Doe",
  "affiliate_code": "1h",
  "referring_affiliate_id": null,
  "created_at": "2024-08-05T13:40:01Z",
  "updated_at": "2024-10-16T17:10:59Z",
  "status": "Active",
  "paypal_email": "affiliate_payment@email.com",
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
  "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
  "compensation_tier_code": "V.I.P.",
  "custom_fields": {
    "custom": "fields"
  },
  "referring_affiliate": null,
  "total_leads": 2,
  "total_visitors": null,
  "total_purchases": 1
}

Retrieve all commissions for a specific affiliate filtering by status.

Query Parameters

keystring Required

The private key

pagestring

The page number for pagination. Defaults to 1.

per_pagestring

The number of records per page. (Default: 20 | Maximum: 200)

statusstring

Filters commissions by status. Accepted values: cancelled (canceled commissions), paid (paid commissions), pending (awaiting approval), due (due for payment), unpaid (unpaid commissions), live (either unpaid or paid status). Omit to retrieve all commissions.

Response

200

Object

Response Attributes

pagenumber

The current page number in the paginated response.

per_pagenumber

The number of records returned per page.

total_entriesnumber

The total number of entries available that match the request criteria.

commissionsarray

Show child attributes

curl --location 'https://api.leaddyno.com/v1/affiliates/ID/commissions/filter?key=YOUR_PRIVATE_KEY&page=1&per_page=20&status=paid' \

{
  "page": 1,
  "per_page": 20,
  "total_entries": 2,
  "commissions": [
    {
      "id": 1,
      "date": "2022-05-19",
      "due_at": "2022-05-19T18:01:24Z",
      "amount": "100.0",
      "currency": "USD",
      "payment_type": "cash",
      "custom_singular": "",
      "custom_plural": "",
      "cancelled": false,
      "note": null,
      "paid": true,
      "purchase": {
        "id": 1,
        "created_at": "2022-05-19T18:01:24Z",
        "updated_at": "2022-05-19T18:01:24Z",
        "cancelled": false,
        "currency": "USD",
        "purchase_code": "x11",
        "note": null,
        "purchase_amount": "100.0",
        "commission_amount_override": null,
        "cancellation": null,
        "lead": {
          "id": 1,
          "email": "lead1@example.com"
        },
        "affiliate": null,
        "plan": null
      },
      "affiliate": {
        "id": 1,
        "email": "affiliate1@example.com"
      }
    }
  ]
}

Retrieve the total commission data (due, pending, paid, and total) in the default currency for a specific affiliate. This section allows users to view a comprehensive overview of an affiliate's commission status at a glance, making it easier to track and manage affiliate earnings effectively.

Query Parameters

keystring Required

Your private key

Response

200

Object

Returns the total commission data (due, pending, paid, and total) in the default currency for a specific affiliate.

Response Attributes

currencystring

duestring

pendingstring

paidstring

totalstring

curl --location 'https://api.leaddyno.com/v1/affiliates/ID/commissions_total?key=YOUR_PRIVATE_KEY' \

{
  "currency": "USD",
  "due": "8.0",
  "pending": "0.0",
  "paid": "3956.67",
  "total": "3964.67"
}

This section allows users to retrieve the purchases associated with a specific affiliate.

Query Parameters

keystring Required

Your private key

pageinteger (int32)

The page number for pagination. Defaults to 1, with 100 records per page.

Response

200

Object

Returns the purchases associated with the affiliate.

Response Attributes

idnumber

created_atstring

updated_atstring

cancelledboolean

currencystring

purchase_codestring

notestring

purchase_amountstring

commission_amount_overridestring

cancellationobject

Show child attributes

leadobject

Show child attributes

affiliateobject

Show child attributes

planobject

Show child attributes

curl --location 'https://api.leaddyno.com/v1/affiliates/ID/purchases?key=YOUR_PRIVATE_KEY&page=1' \

[
  {
    "id": 1104,
    "created_at": "2024-10-07T03:00:00Z",
    "updated_at": "2024-10-16T16:52:51Z",
    "cancelled": true,
    "currency": "USD",
    "purchase_code": "0b01832c-cd02-4120-a698-1c2cd752f587",
    "note": null,
    "purchase_amount": "123.5",
    "commission_amount_override": null,
    "cancellation": {
      "id": 29,
      "cancellation_code": "eee9b192-f42a-4063-8423-1a0dca56bc80",
      "effective_date": "2024-10-16T16:52:51Z",
      "source": null
    },
    "lead": {
      "id": 2152,
      "email": "lead@email.com"
    },
    "affiliate": {
      "id": 17175,
      "email": "affiliate@email.com"
    },
    "plan": {
      "id": 30,
      "code": "default"
    }
  }
]

This section allows users to retrieve leads associated with a specific affiliate.

Query Parameters

keystring Required

Your private key

pageinteger (int32)

The page number for pagination. Defaults to 1, with 100 records per page.

Response

200

Object

Returns the leads associated with the affiliate.

Response Attributes

idnumber

emailstring

created_atstring

updated_atstring

statusstring

custom_statusstring

first_namestring

last_namestring

address1string

address2string

citystring

statestring

zipcodestring

countrystring

latest_visitorstring

urlstring

referrerstring

search_termstring

affiliateobject

Show child attributes

campaignstring

tracking_codestring

crm_dataobject

curl --location 'https://api.leaddyno.com/v1/affiliates/ID/leads?key=YOUR_PRIVATE_KEY&page=1' \

[
  {
    "id": 2152,
    "email": "lead@email.com",
    "created_at": "2024-10-07T18:24:53Z",
    "updated_at": "2024-10-07T18:39:00Z",
    "status": "Cancelled",
    "custom_status": "",
    "first_name": "Test",
    "last_name": "Ruby",
    "address1": null,
    "address2": null,
    "city": null,
    "state": null,
    "zipcode": null,
    "country": null,
    "latest_visitor": null,
    "url": null,
    "referrer": null,
    "search_term": null,
    "affiliate": {
      "id": 17175,
      "email": "affiliate@email.com"
    },
    "campaign": null,
    "tracking_code": null,
    "crm_data": {}
  },
  {
    "id": 2150,
    "email": "lead-2@email.com",
    "created_at": "2024-09-24T03:01:12Z",
    "updated_at": "2024-09-24T03:01:12Z",
    "status": "Registered",
    "custom_status": "",
    "first_name": "FN",
    "last_name": "LN",
    "address1": null,
    "address2": null,
    "city": null,
    "state": null,
    "zipcode": null,
    "country": null,
    "latest_visitor": null,
    "url": null,
    "referrer": null,
    "search_term": null,
    "affiliate": {
      "id": 17175,
      "email": "affiliate@email.com"
    },
    "campaign": null,
    "tracking_code": null,
    "crm_data": {}
  }
]

This endpoint retrieves detailed information about a specific affiliate using their unique ID.

Query Parameters

keystring Required

Your private key

Response

200

Object

Returns the affiliate with the given ID.

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location 'https://api.leaddyno.com/v1/affiliates/ID?key=YOUR_PRIVATE_KEY' \

{
  "id": 1,
  "email": "joe@foo.com",
  "first_name": "asdf",
  "last_name": "asdf",
  "affiliate_code": "joeblowwwww",
  "referring_affiliate_id": null,
  "created_at": "2013-06-03T17:57:24Z",
  "updated_at": "2024-10-09T16:06:30Z",
  "status": "Active",
  "paypal_email": null,
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://localhost.com?afmc=joeblowwwww",
  "affiliate_dashboard_url": "http://myaffiliatedashboard.com/p/3caeff59016736dd538655644abdcefghij",
  "compensation_tier_code": "Affiliatesss",
  "custom_fields": {},
  "referring_affiliate": null,
  "total_leads": 14,
  "total_visitors": 19,
  "total_purchases": 31
}

This endpoint retrieves detailed information about a specific affiliate using their affiliate code.

Query Parameters

keystring Required

Your private key

affiliate_codestring Required

The affiliate's coupon/discount code.

Response

200

Object

Returns the affiliate with the given affiliate code.

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

Show child attributes

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location 'https://api.leaddyno.com/v1/affiliates/by_affiliate_code?key=YOUR_PRIVATE_KEY&affiliate_code=' \

{
  "id": 17175,
  "email": "affiliate@email.com",
  "first_name": "Johnny",
  "last_name": "Doe",
  "affiliate_code": "1h",
  "referring_affiliate_id": null,
  "created_at": "2024-08-05T13:40:01Z",
  "updated_at": "2024-10-16T17:10:59Z",
  "status": "Active",
  "paypal_email": "affiliate_payment@email.com",
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
  "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
  "compensation_tier_code": "V.I.P.",
  "custom_fields": {
    "custom": "fields"
  },
  "referring_affiliate": null,
  "total_leads": 2,
  "total_visitors": null,
  "total_purchases": 1
}

This endpoint retrieves detailed information about a specific affiliate using their affiliate email.

Query Parameters

keystring Required

Your private key

emailstring Required

The email address of the affiliate to retrieve.

Response

200

Object

Returns the affiliate with the given email

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

Show child attributes

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location 'https://api.leaddyno.com/v1/affiliates/by_email?key=YOUR_PRIVATE_KEY&email=affiliate_email%40example.com' \

{
  "id": 17175,
  "email": "affiliate@email.com",
  "first_name": "Johnny",
  "last_name": "Doe",
  "affiliate_code": "1h",
  "referring_affiliate_id": null,
  "created_at": "2024-08-05T13:40:01Z",
  "updated_at": "2024-10-16T17:10:59Z",
  "status": "Active",
  "paypal_email": "affiliate_payment@email.com",
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
  "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
  "compensation_tier_code": "V.I.P.",
  "custom_fields": {
    "custom": "fields"
  },
  "referring_affiliate": null,
  "total_leads": 2,
  "total_visitors": null,
  "total_purchases": 1
}

This endpoint allows users to retrieve the total number of affiliates.

Query Parameters

keystring Required

Response

200

Object

Returns the total number of affiliates.

Response Attributes

countnumber

curl --location 'https://api.leaddyno.com/v1/affiliates/count?key=YOUR_PRIVATE_KEY' \

{
  "count": 41
}

Retrieve a paginated list of all affiliates within your LeadDyno platform.

Query Parameters

keystring Required

Your private key

pageinteger (int32)

The page number for pagination. Defaults to 1, with 100 records per page.

per_pageinteger

Specifies the number of records to display per page. The default value is 100.

querystring

The string you want to find in first_name, last_name, or email field

Response

200

Object

Returns a paginated list of affiliates with their associated links.

Response Attributes

idnumber

The unique identifier for the affiliate.

emailstring

The email address of the affiliate.

first_namestring

The first name of the affiliate.

last_namestring

The last name of the affiliate.

affiliate_codestring

The affiliate code associated with the affiliate.

referring_affiliate_idstring

The unique identifier of the referring affiliate.

created_atstring

The date and time when the affiliate was created.

updated_atstring

The date and time when the affiliate information was last updated.

statusstring

The current status of the affiliate.

paypal_emailstring

The PayPal email associated with the affiliate.

unsubscribedboolean

Indicates if the affiliate has unsubscribed.

archivedboolean

Indicates if the affiliate is archived.

pending_approvalboolean

Indicates if the affiliate is pending approval.

affiliate_urlstring

The URL associated with the affiliate.

affiliate_dashboard_urlstring

The URL for the affiliate's dashboard.

compensation_tier_codestring

The code representing the compensation tier for the affiliate.

custom_fieldsobject

Additional custom fields associated with the affiliate.

Show child attributes

referring_affiliatestring

The name of the referring affiliate.

total_leadsnumber

The total number of leads generated by the affiliate.

total_visitorsnumber

The total number of visitors referred by the affiliate.

total_purchasesnumber

The total number of purchases made through the affiliate's referrals.

curl --location 'https://api.leaddyno.com/v1/affiliates?key=YOUR_PRIVATE_KEY&page=1&per_page=100&query=YOUR_SEARCH_STRING' \

[
  {
    "id": 17175,
    "email": "affiliate@email.com",
    "first_name": "Johnny",
    "last_name": "Doe",
    "affiliate_code": "1h",
    "referring_affiliate_id": null,
    "created_at": "2024-08-05T13:40:01Z",
    "updated_at": "2024-10-16T17:10:59Z",
    "status": "Active",
    "paypal_email": "affiliate_payment@email.com",
    "unsubscribed": false,
    "archived": false,
    "pending_approval": false,
    "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
    "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
    "compensation_tier_code": "V.I.P.",
    "custom_fields": {
      "custom": "fields"
    },
    "referring_affiliate": null,
    "total_leads": 2,
    "total_visitors": null,
    "total_purchases": 1
  },
  {
    "id": 17182,
    "email": "jane.doe@email.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "affiliate_code": "1o",
    "referring_affiliate_id": null,
    "created_at": "2024-08-21T17:14:56Z",
    "updated_at": "2024-08-21T17:15:31Z",
    "status": "Active",
    "paypal_email": "te",
    "unsubscribed": false,
    "archived": false,
    "pending_approval": false,
    "affiliate_url": "http://www.test4.com/discount/1o?redirect=%2F2025%3Fafmc%3D1o",
    "affiliate_dashboard_url": "https://devsupport-staging2.leaddyno.com/p/ad2cc1163a66eaafa3e8210f717230ca47fb8c4b",
    "compensation_tier_code": "V.I.P.",
    "custom_fields": {
      "custom": "fields"
    },
    "referring_affiliate": null,
    "total_leads": null,
    "total_visitors": null,
    "total_purchases": null
  }
]

Unarchive a specific affiliate within LeadDyno. This endpoint allows users to reactivate previously archived affiliates.

Query Parameters

keystring Required

Your private key

Response

201

Object

Unarchives an affiliate.

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

Show child attributes

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location --request POST 'https://api.leaddyno.com/v1/affiliates/ID/unarchive?key=YOUR_PRIVATE_KEY' \

{
  "id": 17175,
  "email": "affiliate@email.com",
  "first_name": "John",
  "last_name": "Doe",
  "affiliate_code": "1h",
  "referring_affiliate_id": null,
  "created_at": "2024-08-05T13:40:01Z",
  "updated_at": "2024-10-16T17:10:59Z",
  "status": "Active",
  "paypal_email": "affiliate_payment@email.com",
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
  "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
  "compensation_tier_code": "V.I.P.",
  "custom_fields": {
    "custom": "fields"
  },
  "referring_affiliate": null,
  "total_leads": 2,
  "total_visitors": null,
  "total_purchases": 1
}

Archives a specific affiliate within LeadDyno. This action moves the affiliate into an inactive state.

Query Parameters

keystring Required

Your private key

Response

201

Object

Archives an affiliate.

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

Show child attributes

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location --request POST 'https://api.leaddyno.com/v1/affiliates/ID/archive?key=YOUR_PRIVATE_KEY' \

{
  "id": 17175,
  "email": "affiliate@email.com",
  "first_name": "John",
  "last_name": "Doe",
  "affiliate_code": "1h",
  "referring_affiliate_id": null,
  "created_at": "2024-08-05T13:40:01Z",
  "updated_at": "2024-10-16T17:10:59Z",
  "status": "Active",
  "paypal_email": "affiliate_payment@email.com",
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
  "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
  "compensation_tier_code": "V.I.P.",
  "custom_fields": {
    "custom": "fields"
  },
  "referring_affiliate": null,
  "total_leads": 2,
  "total_visitors": null,
  "total_purchases": 1
}

This section allows users to reject a specific affiliate within LeadDyno. Users can formally decline affiliates from participating in their affiliate program, ensuring proper management of affiliate registrations.

Query Parameters

keystring Required

Your private key

Response

201

Object

Rejects an affiliate.

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

Show child attributes

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location --request POST 'https://api.leaddyno.com/v1/affiliates/ID/reject?key=YOUR_PRIVATE_KEY' \

{
  "id": 17175,
  "email": "affiliate@email.com",
  "first_name": "John",
  "last_name": "Doe",
  "affiliate_code": "1h",
  "referring_affiliate_id": null,
  "created_at": "2024-08-05T13:40:01Z",
  "updated_at": "2024-10-16T17:10:59Z",
  "status": "Active",
  "paypal_email": "affiliate_payment@email.com",
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
  "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
  "compensation_tier_code": "V.I.P.",
  "custom_fields": {
    "custom": "fields"
  },
  "referring_affiliate": null,
  "total_leads": 2,
  "total_visitors": null,
  "total_purchases": 1
}

This section allows users to approve a specific affiliate within LeadDyno. Users can formally approve affiliates from participating in their affiliate program, ensuring proper management of affiliate registrations.

Query Parameters

keystring Required

Your private key

Response

201

Object

Approves an affiliate.

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

Show child attributes

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location --request POST 'https://api.leaddyno.com/v1/affiliates/ID/approve?key=YOUR_PRIVATE_KEY' \

{
  "id": 17175,
  "email": "affiliate@email.com",
  "first_name": "John",
  "last_name": "Doe",
  "affiliate_code": "1h",
  "referring_affiliate_id": null,
  "created_at": "2024-08-05T13:40:01Z",
  "updated_at": "2024-10-16T17:10:59Z",
  "status": "Active",
  "paypal_email": "affiliate_payment@email.com",
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
  "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
  "compensation_tier_code": "V.I.P.",
  "custom_fields": {
    "custom": "fields"
  },
  "referring_affiliate": null,
  "total_leads": 2,
  "total_visitors": null,
  "total_purchases": 1
}

This section allows users to update the information of a specific affiliate in LeadDyno. Users can modify fields such as email, first name, last name, affiliate code, PayPal email, and other relevant details associated with the affiliate.

Query Parameters

keystring Required

Your private key

Body Parameters

emailstring

The email address of the affiliate.

first_namestring

The first name of the affiliate.

last_namestring

The last name of the affiliate.

affiliate_codestring

The affiliate's discount/coupon code.

paypal_emailstring

The PayPal email address for affiliate payouts.

unsubscribedboolean

Indicates whether the affiliate is unsubscribed from communications.

affiliate_typestring

The compensation tier (affiliate group) code for the affiliate.

referring_affiliatestring

The email of the affiliate that referred this affiliate (MLM).

Response

200

Object

Updates an affiliate's information.

Response Attributes

idnumber

emailstring

first_namestring

last_namestring

affiliate_codestring

referring_affiliate_idstring

created_atstring

updated_atstring

statusstring

paypal_emailstring

unsubscribedboolean

archivedboolean

pending_approvalboolean

affiliate_urlstring

affiliate_dashboard_urlstring

compensation_tier_codestring

custom_fieldsobject

Show child attributes

referring_affiliatestring

total_leadsnumber

total_visitorsnumber

total_purchasesnumber

curl --location --request PUT 'https://api.leaddyno.com/v1/affiliates/ID?key=YOUR_PRIVATE_KEY' \
--data '{
  "email": "",
  "first_name": "",
  "last_name": "",
  "affiliate_code": "",
  "paypal_email": "",
  "unsubscribed": false,
  "affiliate_type": "",
  "referring_affiliate": ""
}'

{
  "id": 17175,
  "email": "affiliate@email.com",
  "first_name": "Johnny",
  "last_name": "Doe",
  "affiliate_code": "1h",
  "referring_affiliate_id": null,
  "created_at": "2024-08-05T13:40:01Z",
  "updated_at": "2024-10-16T17:10:59Z",
  "status": "Active",
  "paypal_email": "affiliate_payment@email.com",
  "unsubscribed": false,
  "archived": false,
  "pending_approval": false,
  "affiliate_url": "http://www.affiliate.dashboard.com/discount/1h?redirect=%2F2025%3Fafmc%3D1h",
  "affiliate_dashboard_url": "https://affiliate.dashboard.com/p/845cd40ce6da84415af84a7f5ff8c92f9a2c23ee",
  "compensation_tier_code": "V.I.P.",
  "custom_fields": {
    "custom": "fields"
  },
  "referring_affiliate": null,
  "total_leads": 2,
  "total_visitors": null,
  "total_purchases": 1
}

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.

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.

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.

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.

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.

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.

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

Sections

LeadDyno API

Just getting started?

Language Box

cURL

Ruby

Python

PHP

Java

Node.js

Go

.NET

Affiliates

What made this section unhelpful for you?

Create a new affiliate

Query Parameters

Body Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve commissions for a specific affiliate filtering by status

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve total commissions for a specific affiliate

Query Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve purchases by affiliate

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve leads associated with an affiliate

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve an affiliate by ID

Query Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve an affiliate by Affiliate Code

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve an affiliate by Email

Query Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Retrieve total number of affiliates

Query Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

List all affiliates

Query Parameters

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response

Response