Set default member credit limit

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Sets the credit limit for every member of a workspace who doesn't have their own, or removes it when default_credit_limit is null. Members with their own limit keep it. List workspace members shows the default in a member's credit_limit, with is_default_limit set to true.

The default can't be more than the workspace's monthly credits. The workspace owner is never limited. Setting the same default again changes nothing, so retrying is safe.

Member credit limits need the Business plan or higher. Below it, this returns a 402.

This is limited to 30 requests per minute, shared with Update workspace member role, Remove workspace member, Set member credit limit, and Set default member credit limit. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.

<Note>Call this as an owner or admin of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused, and workspace API keys aren't accepted.</Note>

put/api/workspace/default-credit-limit

Query parameters

workspaceIdstring required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Request body

default_credit_limitinteger nullable

Most credits each member without their own limit can use in the workspace each month, at least 1. null, or leaving it out, removes the default.

Example request

{
  "default_credit_limit": 300
}

Response

The workspace default changed.

status'success' required

Always success.

messagestring required

Short confirmation. Its wording can change, so don't parse it.

Example response

{
  "status": "success",
  "message": "Members added to group."
}

Changes

Changed in 1 of the 28 revisions of this API.1

Of the 28 revisions, 1 has no diff computed.