v1

latestOpenAPI 3.0.12026-07-243266138.0 KB

Endpoints

Update an event type by ID

This endpoint updates an event type by its [UUID](/reference/uuid-prefixes.

put/event-types/{id}

Path parameters

idstring required

The ID of the event type object.

Headers

Authorizationstring required

An authorisation header containing meta information, see OAuth2.

Request body

activeboolean required

A boolean value that indicates whether the event type is active or not.

If an event type is inactive, events for this type will no longer be accepted.

Example request

{
  "active": true
}

Response

The updated event type.

idstring required

The event type ID as an eTrusted [UUID](/reference/uuid-prefixes.

createdAtstring date-time required

The date and time when the event type was created, in the ISO 8601 and RFC 3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ.

updatedAtstring date-time required

The date and time when the event type was last modified, in the ISO 8601 and RFC 3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ.

activeboolean required

A boolean value that indicates whether the event type is active or not.

If an event type is inactive, events for this type will not be accepted anymore.

namestring required

The name of the event type.

checkout is the default event type for every account.

Please contact us to add more event types for you!

Example response

{
  "id": "ety-b8a7dd0b-2858-49e9-822c-8f4321caae1e",
  "createdAt": "2023-02-14T17:15:30.000Z",
  "updatedAt": "2023-02-14T19:45:50.100Z",
  "active": true,
  "name": "after_sales"
}