Skip to main content
PATCH
/
api
/
affiliate
/
programs
/
{id}
Atualizar programa
curl --request PATCH \
  --url https://upay-sistema-api.onrender.com/api/affiliate/programs/{id} \
  --header 'API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commissionType": "PERCENTAGE",
  "commissionValue": 2,
  "cookieDays": 183,
  "isActive": true,
  "description": "<string>",
  "rules": "<string>",
  "affiliatePage": "<string>",
  "salesPage": "<string>",
  "extendedCommission": true
}
'
{
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "commissionType": "PERCENTAGE",
    "commissionValue": 123,
    "cookieDays": 123,
    "isActive": true,
    "description": "<string>",
    "rules": "<string>",
    "affiliatePage": "<string>",
    "salesPage": "<string>",
    "extendedCommission": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "product": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "price": 123,
      "imageUrl": "<string>",
      "description": "<string>"
    },
    "user": {
      "name": "<string>"
    },
    "_count": {
      "links": 123
    }
  }
}

Authorizations

API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Path Parameters

id
string<uuid>
required

ID do programa de afiliados

Body

application/json
commissionType
enum<string>
Available options:
PERCENTAGE,
FIXED
commissionValue
integer
Required range: x >= 1
Required range: 1 <= x <= 365
isActive
boolean
description
string
Maximum string length: 2000
rules
string | null
Maximum string length: 5000
affiliatePage
string<uri> | null
salesPage
string<uri> | null
extendedCommission
boolean

Response

Programa atualizado com sucesso

message
string
data
object