> ## Documentation Index > Fetch the complete documentation index at: https://docs.spenza.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a sim-group ## OpenAPI ````yaml /openapi.yaml post /api/v1.1/sim-groups openapi: 3.1.0 info: title: Spenza Partner API version: 3.0.0 summary: >- Partner API for SIMs, eSIMs, plans, billing, users, groups and numbers — v1.1 surface. description: > The **Spenza Partner API** lets you manage SIMs, eSIMs, plans, subscriptions, billing, users, phone numbers, teams and device/SIM/user groups programmatically. All endpoints follow one consistent standard: - **Auth** — exchange your API `key` + `secret` for a bearer token, then send `Authorization: Bearer ` on every request. - **Envelopes** — success responses are `{ success, data, meta? }`; errors are `{ success: false, error: { code, message, details? } }`. - **Pagination** — list endpoints accept `page` (1-indexed) and `pageSize` (max 100); totals are returned in `meta`. - **Idempotency** — many write endpoints honor an optional `Idempotency-Key` request header so a retried call replays the original result instead of repeating the side effect. - **Async operations** — a handful of endpoints (eSIM provisioning, port-in, the `/api/v3/...` purchase variants, top-up) return `202` (`201` for top-up) with a `transactionId` + `statusEndpoint` instead of the finished resource. Poll `GET /api/v3/transactions/{transactionId}` (no auth required) until the transaction reaches a terminal status. One resource — **port-in submission** — is a documented exception: it lives at `POST /api/v3/port-in`, requires an Admin-tier account role rather than just a valid bearer token, and is **not** on the standard envelope (see that operation's description for its exact response shape). contact: name: Spenza API Support email: support@spenza.com url: https://spenza.com license: name: Proprietary url: https://spenza.com/terms x-logo: url: https://spenza.com/logo.png altText: Spenza servers: - url: https://api.spenza.com description: Production security: - bearerAuth: [] tags: - name: Authentication description: Exchange API credentials for a bearer token. - name: SIMs description: List, inspect, assign and manage SIMs. - name: Subscriptions description: Plan subscriptions attached to SIMs. - name: Plans & Catalog description: Purchasable plans and SIM products. - name: eSIM description: Provision eSIMs and fetch activation QR / install status. - name: Billing description: Invoices, credit balance and top-ups. - name: Users description: End users (employees) on your account that SIMs/devices are assigned to. - name: Orders & Transactions description: Order history and financial transactions. - name: Numbers & Port-in description: Check port-in eligibility and port existing numbers into Spenza. - name: Messaging description: Send outbound SMS from a provisioned number. - name: Webhooks description: Register endpoints for operator SMS/voice events and inspect deliveries. - name: Notifications description: In-account notifications and delivery preferences. - name: Device Groups description: Organize devices into named groups with spend/data limits. - name: SIM Groups description: Organize SIMs into named groups with spend/data limits. - name: User Groups description: Organize users (departments) into named groups with spend/data limits. - name: Devices description: The device catalog (phones/tablets) and their assignment to users. - name: Team Members description: Admins who manage your Spenza account (distinct from Users/end-users). - name: Async Status description: Universal status poll for any asynchronous (v3) operation. paths: /api/v1.1/sim-groups: post: tags: - SIM Groups summary: Create a sim-group operationId: createSimGroup parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - name properties: name: type: string maxLength: 100 example: Sales Team spendLimit: type: number minimum: 0 dataQuota: type: number minimum: 0 currency: type: string maxLength: 10 example: USD dataUnit: type: string enum: - KB - MB - GB responses: '201': description: Created. content: application/json: example: success: true data: name: Sales Team spendLimit: 1000 dataQuota: 100 currency: USD dataUnit: GB '400': description: Missing `name`, or an invalid field value. content: application/json: example: success: false error: code: VALIDATION_ERROR message: One or more fields failed validation. details: validationErrors: - name should not be empty '409': description: A sim-group with this name already exists. content: application/json: example: success: false error: code: SIM_GROUP_ALREADY_EXISTS message: A sim-group with this name already exists on your account. '429': description: >- Lock contention: another request is already creating a sim-group with this exact name on this account — not the account-wide rate limit. Retry shortly. content: application/json: example: success: false error: code: RATE_LIMITED message: >- Too many concurrent requests for this sim-group name — please retry in a moment. components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: > Any string unique to this logical request. On a retry with the same key and the same request body, the original response is replayed verbatim (with an `Idempotency-Replayed: true` response header) instead of the action repeating. Reusing the key with a **different** body or on a different route returns `409 IDEMPOTENCY_KEY_REUSED`. A replay attempted while the original call is still in flight returns `409 CONFLICT`. Optional — omit it and the endpoint behaves exactly as it would otherwise. schema: type: string example: a1b2c3d4-idem-key-001 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Bearer token obtained from `POST /api/v1.1/auth/token`. ````