Groups

Update a group

is_default: true makes this the group new partners land in and clears the flag on the previous default.

Scope: partners:write (or write)

post/v1/groups/{id}

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/groups/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Prefixed id (grp_…)

Example:grp_7uSyy9FqVLCFWrdPeZaK

Request body

namestring
descriptionstring nullable
landing_urlstring uri nullable
is_privateboolean
is_defaulttrue

Response

The updated group

idstring required

Prefixed id (grp_…)

object'group' required
program_idstring required

Prefixed id (prg_…)

namestring required
slugstring required
descriptionstring nullable required
landing_urlstring nullable required
is_privateboolean required
is_defaultboolean required
created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "grp_7uSyy9FqVLCFWrdPeZaK",
  "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.