v1

latestOpenAPI 3.0.02026-07-261733191.1 MB

Seat Metrics

Create a seat metric

Create a new seat metric which can be used in prices.

post/seat-metrics

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Request body

seatTypestring required

E.g. admin_user. An immutable, unique value used to identify and refer to this seat type. It should be lower snakecase

descriptionstring nullable

Optional description for this seat metric.

labelstring required

Friendly, customer-facing name for this seat metric.

Example request

{
  "seatType": "admin",
  "description": "Allows user to make admin changes over whole account",
  "label": "Administrator"
}

Response

Created

idstring required

Unique ID for this seat metric.

seatTypestring required

Immutable, unique value used to identify and refer to this seat type when submitting events.

createdBystring nullable

The ID of the Sequence user who created this seat metric.

labelstring required

Friendly, customer-facing name for this seat metric.

descriptionstring nullable

Optional description for this seat metric.

createdAtstring required

The time at which this seat metric was created. Formatted as an ISO 8601 timestamp.

updatedAtstring required

The time at which this seat metric was updated. Formatted as an ISO 8601 timestamp.

Example response

{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "seatType": "admin",
  "createdBy": "4ffd439e-32e5-4046-bb40-3cb81f40e5da",
  "label": "Administrator",
  "description": "Allows user to make admin changes over whole account",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z"
}