Update Affiliate

curl -X PUT "https://api.affonso.io/v1/affiliates/cmj8pptm10002p3010z8mk9ak" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "John LLC",
    "country_code": "US",
    "payout_method": "paypal",
    "payout_details": {
      "email": "john@example.com"
    },
    "status": "approved",
    "external_user_id": "user_456",
    "metadata": {
      "plan": "enterprise"
    }
  }'

{
  "success": true,
  "data": {
    "id": "cmj8pptm10002p3010z8mk9ak",
    "name": "John Doe",
    "email": "john@example.com",
    "tracking_id": "john-doe",
    "source": "api",
    "partnership_status": "APPROVED",
    "onboarding_completed": false,
    "program_id": "cm7xutqbb0001yfkcrnpextmp",
    "group_id": null,
    "external_user_id": "user_456",
    "metadata": {
      "plan": "enterprise"
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
}

PUT

affiliates

{id}

curl -X PUT "https://api.affonso.io/v1/affiliates/cmj8pptm10002p3010z8mk9ak" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "John LLC",
    "country_code": "US",
    "payout_method": "paypal",
    "payout_details": {
      "email": "john@example.com"
    },
    "status": "approved",
    "external_user_id": "user_456",
    "metadata": {
      "plan": "enterprise"
    }
  }'

{
  "success": true,
  "data": {
    "id": "cmj8pptm10002p3010z8mk9ak",
    "name": "John Doe",
    "email": "john@example.com",
    "tracking_id": "john-doe",
    "source": "api",
    "partnership_status": "APPROVED",
    "onboarding_completed": false,
    "program_id": "cm7xutqbb0001yfkcrnpextmp",
    "group_id": null,
    "external_user_id": "user_456",
    "metadata": {
      "plan": "enterprise"
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Path Parameters

string

required

The unique identifier of the affiliate to update

Body Parameters

All body parameters are optional. Only include the fields you want to update.

string

Update the affiliate’s display name. Must be between 1 and 100 characters.

string

Update the affiliate’s email address. Must be a valid email format. If the email is already in use by another user, the request will fail with a conflict error.

string | null

Affiliate group ID (null to remove).

string | null

Company name for invoice. Maximum 100 characters. Set to null to clear.

string | null

2-letter ISO country code. Set to null to clear.

string

Payout method (none to remove). Valid values: paypal, wise, payoneer, paxum, webmoney, skrill, wire_transfer, bitcoin, ethereum, alipay, wechat, manual, none.

object

Payout details (snake_case fields). The required fields depend on the payout_method:

Email-based methods (paypal, wise, payoneer, paxum, skrill): email (string, valid email)
ID-based methods (webmoney, alipay, wechat): account_id (string)
Crypto methods (bitcoin, ethereum): address (string, wallet address)
Wire transfer (wire_transfer): bank_name, account_number, swift_code, iban, routing_number, account_name (all strings)
Manual (manual): No details required

string

Partnership approval status. Valid values: pending, approved, rejected.

string | null

Your external user ID for linking referral users to your own user system. Set to null to clear.

object | null

Custom key-value data for storing additional information about the affiliate. Set to null to clear.

Response

The response includes the updated affiliate object with the same structure as the create endpoint.

boolean

Always true for successful responses

object

The updated affiliate object.

Show Data Object Properties

string

Unique identifier for the affiliate

string

The affiliate’s display name

string

The affiliate’s email address

string

Unique tracking ID for the affiliate

string

Source of the affiliate creation

string

Partnership status with the program: "PENDING", "APPROVED", "REJECTED", or null

boolean

Whether the affiliate has completed their onboarding process

string

The affiliate program ID the affiliate is assigned to

string | null

The affiliate group ID if assigned, otherwise null

string | null

Your external user ID if set, otherwise null

object | null

Custom key-value data if set, otherwise null

string

ISO 8601 timestamp of when the affiliate was created

curl -X PUT "https://api.affonso.io/v1/affiliates/cmj8pptm10002p3010z8mk9ak" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "John LLC",
    "country_code": "US",
    "payout_method": "paypal",
    "payout_details": {
      "email": "john@example.com"
    },
    "status": "approved",
    "external_user_id": "user_456",
    "metadata": {
      "plan": "enterprise"
    }
  }'

{
  "success": true,
  "data": {
    "id": "cmj8pptm10002p3010z8mk9ak",
    "name": "John Doe",
    "email": "john@example.com",
    "tracking_id": "john-doe",
    "source": "api",
    "partnership_status": "APPROVED",
    "onboarding_completed": false,
    "program_id": "cm7xutqbb0001yfkcrnpextmp",
    "group_id": null,
    "external_user_id": "user_456",
    "metadata": {
      "plan": "enterprise"
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
}

Note: To retrieve updated related data like promo codes, commission overrides, invoice details, and payout methods, use GET /v1/affiliates/{id}?expand=promoCodes,commissionOverrides,invoiceDetails,payoutMethod.

Getting Started

Guide

Core Resources

Program Management

Marketplace

Path Parameters

Body Parameters

Response

​Path Parameters

​Body Parameters

​Response

Path Parameters

Body Parameters

Response