Delete an invitation

DELETE/v1/api/store/{team_slug}/setting/invite/{invite}

v1Operation ID v1_public_invite_destroy

Withdraws an invitation: its link stops working and it no longer counts toward your plan's user limit. No email is sent. The path takes the invitation's id from the list: a UUID, not a hash id.

Permission

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

Path parameters

• team_slugstringrequired

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

  • Example your-team
• invitestring (uuid)required

  The invitation's id from the invitation list: a UUID, not a hash id.

  • Example 0b5e8c1a-3f4d-4c2b-9a7e-1d2c3b4a5f60

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

  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

  No invitation of your team has this id. error.code is null; error.message names the record type.

  Fix

  Use an id from the invitations list.

Related

• GETList invitations/v1/api/store/{team_slug}/setting/invite
• POSTInvite someone to the team/v1/api/store/{team_slug}/setting/invite

Example request

curl

curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/setting/invite/0b5e8c1a-3f4d-4c2b-9a7e-1d2c3b4a5f60' \  -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
}