Affiliates

Create a partner

Adds a partner with a primary referral link. Use it to turn your own customers into referrers from inside your app. A token you pass is kept exactly or the call fails with 409; without one, a free token is derived from the name.

post/affiliates

Request

  • Base URL: https://api.supersendtx.com
  • URL: https://api.supersendtx.com/affiliates
  • Auth: HTTP bearer

Request body

emailstring email required
first_namestring
last_namestring
companystring
websitestring uri
countrystring

ISO 3166-1 alpha-2

campaign_idstring

Campaign id or name. The default campaign when omitted.

tokenstring

Primary link token. 409 if taken.

status'active' | 'pending' | 'invited'
paypal_emailstring email
tagsstring[]
notesstring

Private to your team

send_inviteboolean

Send the welcome (or invite) email

Response

Partner created

Example response

{
  "affiliate": {
    "links": [
      {
        "token": "jane",
        "url": "https://acme.com/?via=jane"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.