PUT
/
affiliates
/
{id}
curl --request PUT \
  --url https://public-api.kiwify.com/v1/affiliates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-kiwify-account-id: <api-key>' \
  --data '{
  "commission": 4600,
  "status": "active"
}'
{
  "affiliate_id": "c52ccea4-2b5a-4d03-b53a-d9dc96756fc0",
  "name": "MY Affiliate",
  "email": "myaffiliate@mail.com",
  "company_name": "MY Affiliate",
  "director_cpf": "99999999999",
  "company_cnpj": "",
  "product": {
    "id": "aaa86f40-d7ae-11ed-acc6-e1c45591a30e",
    "name": "My Product"
  },
  "commission": 4600,
  "status": "active",
  "created_at": "2023-07-24T15:56:26.189Z"
}

Authorizations

​
x-kiwify-account-id
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

Body

application/json
​
commission
number
Example:

4600

​
status
enum<string>
Available options:
active,
blocked,
refused
Example:

"active"

Response

200
application/json
Affiliate data
​
affiliate_id
string
Example:

"3d103172-04b3-44ef-b2b2-ef0f97db4f37"

​
name
string
Example:

"Meu Afiliado"

​
email
string
Example:

"meuafiliado@gmail.com"

​
company_name
string
Example:

"Meu afiliado"

​
director_cpf
string
Example:

"99999999999"

​
company_cnpj
string
Example:

"99999999999999"

​
product
object
​
commission
number
Example:

4600

​
status
string
Example:

"active"

​
created_at
string
Example:

"2023-07-24T15:56:26.189Z"