Skip to content
Indiana
Dashboard
Docs
Browse docs / Assign or release seat

Assign or release seat

POST/api/v1/seats/manage

Assign identified customers within purchased capacity; billed quantity changes use a confirmed Funnel action.

SDK 0.0.1Updated

Make the request

Assign identified customers within purchased capacity; billed quantity changes use a confirmed Funnel action.

Credential
Server API key only. Call from your trusted backend.
Permission
billing:write
Set the base URL and App ID from SDK setup. These examples use placeholders and do not execute requests. Never put a server key in browser code.
For this Web Beta, configure the Stripe Sandbox test account and published price mappings before checkout. Redirects do not confirm payment.
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/seats/manage" \  -H "Authorization: Bearer $GROOVE_SECRET_KEY" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "customerId": "00000000-0000-4000-8000-000000000001",  "requestId": "00000000-0000-4000-8000-000000000001",  "action": "assign",  "poolId": "00000000-0000-4000-8000-000000000001",  "memberCustomerId": "00000000-0000-4000-8000-000000000001"}'

The response tab lists field types, not an example payload. Actual values depend on customer state.

Request parameters

JSON body

customerIduuid | uuid | uuidRequired

Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.

requestIduuid | uuid | uuidRequired

Business request UUID. Reuse for retries of one operation; generate a new value for a new operation.

action"assign" | "assign_entity" | "release"Required

Business action. Target fields and quantity requirements vary by action; see the request structure and example.

poolIduuid | uuid | uuidRequired

Credit pool UUID in the current scope.

memberCustomerIduuidOptional

The memberCustomerId value for this operation. Its accepted type and constraints are listed above and below.

entityIduuidOptional

Entity ID within the current customer scope, for configured entity and license features.

slotIduuidOptional

The slotId value for this operation. Its accepted type and constraints are listed above and below.

Response fields

Successful responses include requestId and scope. Use the actual business status or accepted field to determine the result. Optional fields are omitted when unavailable.

HTTP 200 · application/json

requestIduuidRequired

Server-generated HTTP request UUID. Include it when reporting a failed request.

scopeobjectRequired

The App and environment of this response. Headers only verify scope; they cannot switch key scope.

Show child fields
projectIdstringRequired

App ID bound to the credential.

minLength: 1

environmentenumRequired

Separate data scope: sandbox or live.

Show allowed values

"sandbox""live"

seatsobjectRequired

The seats value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
customerIduuidRequired

Indiana customer ID mapped from a verified identity on the server. Omit for customer-token calls, which use the token-bound customer.

poolsarrayRequired

The pools value for this operation. Its accepted type and constraints are listed above and below.

maxItems: 2000

Show child fields
iduuidRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

membershipIduuidRequired

The membershipId value for this operation. Its accepted type and constraints are listed above and below.

entityIduuid | nullRequired

Entity ID within the current customer scope, for configured entity and license features.

keystringRequired

The key value for this operation. Its accepted type and constraints are listed above and below.

namestringRequired

Display name of the customer or object; not an identity key.

entitlementVersionIduuidRequired

The entitlementVersionId value for this operation. Its accepted type and constraints are listed above and below.

memberProductVersionIduuidRequired

The memberProductVersionId value for this operation. Its accepted type and constraints are listed above and below.

includedQuantityintegerRequired

The includedQuantity value for this operation. Its accepted type and constraints are listed above and below.

min: 0 · max: 9007199254740991

quantityintegerRequired

Use the declared field type for business quantity. Credit operations use decimal strings to avoid floating-point error. quote/reserve/confirm/refund require positive quantities; consume can record zero-cost events.

min: 0 · max: 9007199254740991

maximumQuantityintegerRequired

The maximumQuantity value for this operation. Its accepted type and constraints are listed above and below.

min: 0 · max: 9007199254740991

assignedQuantityintegerRequired

The assignedQuantity value for this operation. Its accepted type and constraints are listed above and below.

min: 0 · max: 9007199254740991

availableQuantityintegerRequired

The availableQuantity value for this operation. Its accepted type and constraints are listed above and below.

min: 0 · max: 9007199254740991

accessEnabledbooleanRequired

The accessEnabled value for this operation. Its accepted type and constraints are listed above and below.

requireAssignmentbooleanRequired

The requireAssignment value for this operation. Its accepted type and constraints are listed above and below.

pendingChangeobject | nullRequired

The pendingChange value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
receiptIduuidRequired

The receiptId value for this operation. Its accepted type and constraints are listed above and below.

quantityintegerRequired

Use the declared field type for business quantity. Credit operations use decimal strings to avoid floating-point error. quote/reserve/confirm/refund require positive quantities; consume can record zero-cost events.

min: 0 · max: 10000

timingenumRequired

Immediate or end-of-cycle timing, only for supported plan-change actions.

Show allowed values

"immediate""renewal"

statusenumRequired

The status value for this operation. Its accepted type and constraints are listed above and below.

Show allowed values

"prepared""quoted""confirmed""pending""scheduled"

effectiveAtdate-timeRequired

The effectiveAt value for this operation. Its accepted type and constraints are listed above and below.

periodobjectRequired

The period value for this operation. Its accepted type and constraints are listed above and below.

Show child fields
startsAtdate-timeRequired

The startsAt value for this operation. Its accepted type and constraints are listed above and below.

endsAtdate-time | nullRequired

The endsAt value for this operation. Its accepted type and constraints are listed above and below.

slotsarrayRequired

The slots value for this operation. Its accepted type and constraints are listed above and below.

maxItems: 10000

Show child fields
iduuidRequired

The id value for this operation. Its accepted type and constraints are listed above and below.

poolIduuidRequired

Credit pool UUID in the current scope.

positionintegerRequired

The position value for this operation. Its accepted type and constraints are listed above and below.

max: 9007199254740991

memberCustomerIduuid | nullRequired

The memberCustomerId value for this operation. Its accepted type and constraints are listed above and below.

entityIduuid | nullRequired

Entity ID within the current customer scope, for configured entity and license features.

assignedAtdate-timeRequired

The assignedAt value for this operation. Its accepted type and constraints are listed above and below.

releasedAtdate-time | nullRequired

The releasedAt value for this operation. Its accepted type and constraints are listed above and below.

limitedbooleanRequired

The limited value for this operation. Its accepted type and constraints are listed above and below.

Handle errors

Common failures
CodeRecovery
UNAUTHENTICATEDVerify the key or refresh the expired customer token once.
FORBIDDENCheck current key permissions and customer access.
INVALID_REQUESTCheck field types, UUIDs, decimal strings and mutually exclusive fields.
SCOPE_MISMATCHUse the App and environment bound to the credential.

Common failures

  • UNAUTHENTICATED

    Recovery
    Verify the key or refresh the expired customer token once.

  • FORBIDDEN

    Recovery
    Check current key permissions and customer access.

  • INVALID_REQUEST

    Recovery
    Check field types, UUIDs, decimal strings and mutually exclusive fields.

  • SCOPE_MISMATCH

    Recovery
    Use the App and environment bound to the credential.

Related:All request and error conventions·Back to endpoint index