Update Affiliate - Salla Merchants APIs

This endpoint allows you to update details regarding an affiliate by passing the affiliate_id as a path parameter.

Scopes

marketing.read_write- Marketing Read & Write

curl --location --request PUT 'https://api.salla.dev/admin/v2/affiliates/' \ --header 'Content-Type: application/json' \ --data-raw '{ "code": "frm11", "marketer_name": "User Name", "marketer_city": "Medina", "commission_type": "fixed", "amount": 100, "apply_to": "first_order", "notes": "Notes Here" }'

{ "status": 200, "success": true, "data": { "id": 611208326, "code": "frm11", "marketer_name": "User Name", "marketer_city": "Medina", "commission_type": "fixed", "amount": { "amount": 300, "currency": "SAR" }, "profit": { "amount": 150, "currency": "SAR" }, "links": { "affiliate": "https://salla.sa/dev-wofftr4xsra5xtlv?utm_source=aff&utm_campaign=CXNAZ", "statistics": "https://salla.sa/dev-wofftr4xsra5xtlv/marketing/statistics/1604086218" }, "apply_to": "first_order", "visits_count": 17, "notes": "Notes Here" } }

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

affiliates_id

string

required

Unique identification number assigned to the Affiliate. List of Affiliate IDs can be found here.

Body Params application/json

code

string

optional

Affiliate Code. It must be 5 characters, only English letters or Numbers are valid.

Example:

frm11

marketer_name

string

required

Marketer name.

Example:

User Name

marketer_city

string

required

Marketer city.

Example:

Medina

commission_type

enum<string>

required

Commission type, which can be either fixed or percentage.

Allowed values:

fixedpercentage

Example:

fixed

amount

number

required

Marketing amount.

Example:

100

apply_to

enum<string>

required

Where the affiliatelink should be applied to. Available values are all_orders or first_order.

Allowed values:

first_orderall_orders

Example:

first_order

notes

string

optional

Additional notes.

Example:

Notes Here

Examples

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (Affiliate)

optional

number

required

Affiliate unique identifier. Affiliate list can be found here.

Example:

611208326

code

string

required

Affiliate unique code.

Example:

frm11

marketer_name

string

required

Affiliate marketing name

Example:

User Name

marketer_city

string

required

Affiliate marketing city

Example:

Medina

commission_type

enum<string>

required

If comission_type is fixed, then use a numeric value such as 100. If comission_type is percentage, then use a percentage value such as 15%.

Allowed values:

fixedpercentage

Example:

fixed

amount

object

required

profit

object

required

links

object

required

apply_to

string

required

Where the affiliate link should be applied. Available values are all_orders or first_order

Example:

first_order

visits_count

number

required

Link visit counts

Example:

notes

string

required

Additional notes.

Example:

Notes Here

🟠404Not Found

🟠422Error Validation

🟠401Unauthorized