Move a member to a permission group

PATCH/v1/api/store/{team_slug}/setting/group/{id}/change_user_group

v1Operation ID v1_public_group_change_user_group

Puts a team member in this permission group, taking them out of their current one, and returns the member with their group.

The path id is the group; user_id is the member. The new permissions apply at once.

Permission

Needs the Manage Settings permission.

Business rules

• user_id must be a member of this team.

Side effects

• The member's permissions change at once.
• Tells the team's open web app sessions about the change.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• idstringrequired

  The permission group's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example aaNZmyj0mvmWLU

Request body

application/json, required.

• user_idstringrequired

  The member's id, from List team members.

Response

200Successful response.

• dataobjectrequired
  Child fields (8)

  • emailstringrequired
  • idstringrequired
  • is_ownerbooleanrequired
  • namestringrequired
  • rolesarray of objectsrequired

    The member's permission group.

    Fields of each item (2)

    • idstring
    • namestring
  • avatar_urlstring | null
  • last_login_atstring (date-time) | null
  • timezonestring | null
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No such group, or user_id is not a member of this team.

  Fix

  Use ids from List permission groups and List team members.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  user_id is missing or is not a hash id. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

Related

• GETList permission groups/v1/api/store/{team_slug}/setting/group
• GETList team members/v1/api/store/{team_slug}/setting/user

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/setting/group/aaNZmyj0mvmWLU/change_user_group' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "user_id": "ZiGXY6Fzqgi3AM"  }'

Example response 200

Response

{
  "data": {
    "avatar_url": null,
    "email": "alex@example.com",
    "id": "ZiGXY6Fzqgi3AM",
    "is_owner": false,
    "last_login_at": "2026-11-03T15:00:00+00:00",
    "name": "Alex Rivera",
    "roles": [
      {
        "id": "aaNZmyj0mvmWLU",
        "name": "Sales Team"
      }
    ],
    "timezone": "America/New_York"
  },
  "status": 200,
  "success": true
}