Seat Metrics

Update a seat metric

Changed on

Update a seat metric which can be used in prices.

put/seat-metrics/{id}

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/seat-metrics/{id}
  • Auth
    none declared. Required headers: Authorization

Path parameters

idstring required

id

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Request body

descriptionstring nullable

Optional description

labelstring required

Friendly, customer-facing name for this seat metric.

Example request

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

Response

OK

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"
}

Changes

  • c48cffa2c23dRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      the request property became nullable

  • 55aec2d373b0Revision changes
    • warning

      deleted the header request parameter sequence-version

    • info

      added the new optional header request parameter Sequence-Version