Skip to main content

Create a grid

Use this example to create and assign a grid card with a raw Administration API request.

Before you begin, authenticate the Admin API application and obtain an auth token.

The Admin API application requires the GRIDS:ADD permission. Submit a request to create a grid card and assign it to a user. Replace {userId} with the user's UUID.

  • Method: POST
  • Path: /api/web/v2/users/{userId}/grids

Example request header​

Authorization: Bearer <auth-token>

Example request body​

No request body is required for this example. Omit it to use the default grid settings, or provide optional parameters to set values such as the initial state or serial number.

Example response body​

HTTP 200 returns the created grid card. The following partial response omits most grid cells:

{
  "id": "6c5ad3b4-888c-4d3b-88f2-8ab71ae4f917",
  "serialNumber": 2,
  "gridContents": [["TP", "0M", "P8", "KW"]],
  "userId": "2c422a2f-e8ae-4af8-8b03-e1ce0ddde0b0",
  "userName": "john"
}

Treat gridContents as authentication credentials. Do not log the values or expose them beyond the intended recipient. For optional request fields, the complete response schema, and error responses, see Create a grid.