Publish an event (API token, merchant:write). With externalRef the create is idempotent: a repeat returns the existing event (200, existing: true).

POST /v1/integration/events

Error

A valid request URL is required to generate request examples

200

{
  "event": {
    "id": "<string>",
    "merchantId": "<string>",
    "title": "<string>",
    "startsAt": "<string>",
    "externalRef": "<string>"
  },
  "existing": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

merchantId · string · required

Required string length: 1 - 200

title · string · required

Minimum string length: 1

startsAt · string<date-time> · required

location · object

Show child attributes

externalRef · string

Required string length: 1 - 200

Response

200

application/json

Default Response

event · object · required

Show child attributes

existing · boolean