Remove user from group | Sample

1 parameter

group_membership_idstringrequired

The ID of the group membership.

2 status codes

204A blank response is returned if the membership was successfully deleted.

defaultAn unexpected client error.

typestringoptional

The value will always be `error`.

Allowed:error

statusintegeroptional

The HTTP status of the response.

codestringoptional

A Box-specific error code.

Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed

messagestringoptional

A short message describing the error.

context_infoobjectoptional

A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.

help_urlstringoptional

A URL that links to more information about why this error occurred.

request_idstringoptional

A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: {
    clientId: process.env.CLIENT_ID,
    clientSecret: process.env.CLIENT_SECRET,
  },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.groupMemberships.delete({ groupMembershipId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

Request

Response

Errors