Update affiliate

PUT

/affiliates/{id}

Authorization

`Authorization`
Required
Bearer <token>

API key authentication. Use your API key as the bearer token. The organization that owns the key must have an active or trialing PromoteKit subscription; otherwise requests fail with a 403 subscription_error.

In: header

Request Body

application/jsonRequired

`email`string

Affiliate email

Format: "email"

`first_name`string

First name

`last_name`string

Last name

`payout_email`string

Payout email address

Format: "email"

`ref_code`string

Unique code that goes at the end of the affiliate link

`promo_code`string

Stripe promo code (will be generated if it doesn't already exist in Stripe)

`campaign_id`string

Campaign UUID to assign the affiliate to

Format: "uuid"

`approved`boolean

Whether the affiliate has been approved to start promoting

`banned`boolean

Whether the affiliate is banned. Banned affiliates are not eligible for future commissions and payouts.

`details`string

Additional details

`new_paid_referral_notifications`boolean

Whether the affiliate receives email alerts when they make a new paid referral

Path Parameters

`id`
Required
string

Resource UUID

Format: "uuid"

curl -X PUT "https://www.promotekit.com/api/v1/affiliates/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "first_name": "string",
    "last_name": "string",
    "payout_email": "user@example.com",
    "ref_code": "string",
    "promo_code": "string",
    "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
    "approved": true,
    "banned": true,
    "details": "string",
    "new_paid_referral_notifications": true
  }'

Affiliate updated

{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "email": "user@example.com",
    "first_name": "string",
    "last_name": "string",
    "payout_email": "user@example.com",
    "links": [
      {
        "url": "string",
        "code": "string"
      }
    ],
    "promo_codes": [
      {
        "code": "string",
        "external_id": "string"
      }
    ],
    "clicks": 0,
    "approved": true,
    "banned": true,
    "details": "string",
    "custom_fields": [
      {
        "id": "string",
        "label": "string",
        "value": "string"
      }
    ],
    "new_paid_referral_notifications": true,
    "created_at": "2019-08-24T14:15:22Z",
    "campaign": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "website_url": "string",
      "commission_type": "percentage",
      "commission_amount": 0,
      "is_default": true,
      "limit_type": "string",
      "limit_amount": 0,
      "code_mode": "link",
      "reference_coupon": "string",
      "custom_commission_type": "string",
      "welcome_message": "string",
      "approval_needed": true,
      "collect_details": true,
      "details_text": "string",
      "custom_fields": [
        {
          "id": "string",
          "label": "string",
          "type": "text",
          "options": [
            "string"
          ],
          "required": true
        }
      ],
      "hide_emails": true,
      "dashboard_text": "string",
      "cookie_duration": 0,
      "first_payment_commission": {
        "enabled": true,
        "type": "string",
        "amount": 0
      }
    }
  }
}

Path

Body

Authorization

AuthorizationRequiredBearer <token>

Request Body

emailstring

first_namestring

last_namestring

payout_emailstring

ref_codestring

promo_codestring

campaign_idstring

approvedboolean

bannedboolean

detailsstring

new_paid_referral_notificationsboolean