Skip to main content
PUT
Amend event

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

event_id
string
required

Body

application/json
event_name
string
required

A name to meaningfully identify the action or event type.

timestamp
string<date-time>
required

An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period.

Example:

"2020-12-09T16:09:53Z"

properties
Properties · object
required

A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed.

customer_id
string | null

The Orb Customer identifier

external_customer_id
string | null

An alias for the Orb customer, whose mapping is specified when creating the customer

Response

OK

amended
string
required

event_id of the amended event, if successfully ingested