Remove a member from the team

DELETE/v1/api/store/{team_slug}/setting/user/{hash_id}

v1Operation ID v1_public_user_destroy

Takes a person off the team. Their access to this team ends at once, including through their API keys and AI apps. Their YoPrint account stays, and so does everything they created or did on the team.

The team owner can't be removed: transfer ownership first.

Permission

Needs the Manage Settings permission. The team owner always has it.

Business rules

• The owner can't be removed (403 owner_cannot_be_removed).
• Nothing stops you from removing yourself; you lose access to the team at once. AI apps can't remove their own person.

Side effects

• Their permission group on this team is cleared.
• Team members who have YoPrint open see them disappear at once.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The team member, from the member list. Its hash id from an earlier answer; there is no unique key for it.

  • Example E6LjYJJimQNFVF

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

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

• 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

  The person is the team owner: error.code owner_cannot_be_removed, "The team owner cannot be removed. Transfer ownership first." Nothing changes.

  Fix

  Transfer ownership to someone else first.

  When

  Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.

  Fix

  Use the key of a member whose role has Manage Settings, or the owner's.

• 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

  The person is not on this team.

  Fix

  Use an id from the members list.

Related

• GETList team members/v1/api/store/{team_slug}/setting/user
• POSTTransfer team ownership/v1/api/store/{team_slug}/setting/user/{hash_id}/make_owner

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/setting/user/E6LjYJJimQNFVF' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}