Bulk update campaign affiliates

Sets default affiliate tags for up to 300 creators in one request. Valid rows still update when another row fails. Each success fires campaign_affiliate.code_updated.

PATCH /campaign_affiliates/bulk

cURL

curl -X PATCH "https://api.growi.io/api/public/v1/campaign_affiliates/bulk" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "affiliates": [
         { "id": 3490313, "tag": "OLLYCODE" },
         { "id": 3490314, "tag": "SURESH10" }
       ]
     }'

200

{
  "success": true,
  "updated": [
    { "id": 3490313, "tag": "ollycode" },
    { "id": 3490314, "tag": "suresh10" }
  ],
  "errors": []
}

Sets default affiliate tags for many creators in one request. Built for spoken-code migrations (keep the codes creators already use when you move them onto a revenue campaign).

Each row is independent: valid rows still update when another row fails. Codes must be unique inside your organization. Each successful rename fires campaign_affiliate.code_updated.

Maximum 300 affiliates per request.

Request body

Field	Type	Description	Required
affiliates	Array	Rows to update. Each row needs id (campaign-affiliate enrollment ID) and tag (new code).	Yes

Request example

curl -X PATCH "https://api.growi.io/api/public/v1/campaign_affiliates/bulk" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "affiliates": [
         { "id": 3490313, "tag": "OLLYCODE" },
         { "id": 3490314, "tag": "SURESH10" }
       ]
     }'

Response example

All rows succeeded:

{
  "success": true,
  "updated": [
    { "id": 3490313, "tag": "ollycode" },
    { "id": 3490314, "tag": "suresh10" }
  ],
  "errors": []
}

Partial failure (HTTP 422 — successful rows are still saved):

{
  "success": false,
  "updated": [
    { "id": 3490313, "tag": "ollycode" }
  ],
  "errors": [
    { "id": 0, "error": "Campaign affiliate not found." }
  ]
}

Authentication

Send your organization’s public API key as a Bearer token. Viewer (read-only) keys cannot call this. See Rate Limits & Authentication.

Error responses

Status	Body	When
401	{ "error": "Not Authenticated" }	Missing or invalid API key.
403	{ "error": "This API key is read-only and cannot modify data." }	Viewer key.
422	{ "error": "affiliates is required" }	Missing / empty affiliates.
422	{ "error": "Maximum 300 affiliates per request." }	More than 300 rows.
422	{ "success": false, "updated": [...], "errors": [...] }	At least one row failed. Successful rows are still saved.

cURL

curl -X PATCH "https://api.growi.io/api/public/v1/campaign_affiliates/bulk" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "affiliates": [
         { "id": 3490313, "tag": "OLLYCODE" },
         { "id": 3490314, "tag": "SURESH10" }
       ]
     }'

200

{
  "success": true,
  "updated": [
    { "id": 3490313, "tag": "ollycode" },
    { "id": 3490314, "tag": "suresh10" }
  ],
  "errors": []
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

affiliates · object[] · required

Maximum array length: 300

Show child attributes

Response

200

application/json

Every row updated

success · boolean

Example:

true

updated · object[]

Show child attributes

errors · object[]

Show child attributes