Skip to main content

This page is also available as plain markdown · OpenAPI spec

Delete occurrence

DELETE 

/events/:eventId/occurrences/:id

Delete occurrence

Request

Path Parameters

    eventIdstringrequired
    Example: 00000000-0000-0000-0000-000000000000
    idstringrequired
    Example: 00000000-0000-0000-0000-000000000000

200

Hard-deletes an occurrence with no connected records
metaobjectrequired
requestIdstringrequired
Example: hard-deletes_an_occurrence_with_no_connected_records
{
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

403

Hard-deletes an occurrence with no connected records
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

404

Hard-deletes an occurrence with no connected records
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example (auto)
{
  "object": "string",
  "status": 0,
  "message": "string",
  "meta": {
    "requestId": "string"
  }
}

422

Hard-deletes an occurrence with no connected records
objectstringrequired
statusintegerrequired
messagestringrequired
errorsobject[]required
messagestring
metaobjectrequired
requestIdstringrequired
Example: returns_422_for_a_past_occurrence
{
  "object": "error",
  "status": 422,
  "message": "Validation failed",
  "errors": [
    {
      "message": "Past events cannot be cancelled"
    }
  ],
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}