Worked request and response samples

Copy a request body as written, substitute your own ids, and compare the response envelope. Errors follow Devotel Orbit’s { error, meta } envelope, shown once below under Error envelope.

Create a ticket

POST /api/v1/inbox/tickets

Request

{
  "subject": "Refund request",
  "channel": "email",
  "contact_id": "contact_4d2f6a8c1e3b5d7f9a1c3e5b",
  "priority": "normal"
}

{
  "data": {
    "id": "tick_9e8d7c6b5a4f3021e5d6c7b8",
    "subject": "Refund request",
    "status": "open"
  },
  "meta": {
    "request_id": "req_ticket",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Add a comment to a ticket

POST /api/v1/inbox/tickets/{id}/comments

Request

{
  "body": "We'll refund the difference within 2 business days.",
  "kind": "public"
}

{
  "data": {
    "id": "cmt_5d6c7e8f9a1b2c3d4e5f6a7b",
    "kind": "public",
    "body": "We'll refund the difference within 2 business days."
  },
  "meta": {
    "request_id": "req_comment",
    "timestamp": "2026-08-01T12:01:00.000Z"
  }
}

GET /api/v1/inbox/tickets/{id}/links

string

Optional edge-kind filter, e.g. related or duplicate.

{
  "data": [
    {
      "from": "tick_9e8d7c6b5a4f3021e5d6c7b8",
      "to": "tick_2b3c4d5e6f7081a2b3c4d5",
      "kind": "related"
    }
  ],
  "meta": {
    "request_id": "req_links",
    "timestamp": "2026-08-01T11:59:00.000Z"
  }
}

Error envelope

422

{
  "error": {
    "code": "VALIDATION_ERROR",
    "status": 422,
    "message": "subject: Required"
  },
  "meta": {
    "request_id": "req_...",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

API Reference

All Endpoints

Worked request and response samples

Worked request and response samples

Create a ticket

Add a comment to a ticket

Error envelope

​Worked request and response samples

​Create a ticket

​Add a comment to a ticket

​List a ticket’s related tickets

​Error envelope

Worked request and response samples

Create a ticket

Add a comment to a ticket

List a ticket’s related tickets

Error envelope