Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Shuffl support API

6 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

support.get

Read one Shuffl support conversation

POST/api/v1/manage/support/get

const result = await shuffl.support.get({
  "threadId": "<threadId>"
});
Request fields (2)
  • mine false | true optional
  • threadId string required
Response object
  • canReviewDelivery boolean required
  • messages object[] required
    • authorId null | string required
    • authorRole "customer" | "email" | "operator" required
    • body string required
    • createdAt string (date-time) required
    • delivery null | object required
      • id string required
      • messageId null | string required
      • state "attempting" | "canceled" | "failed" | "pending" | "sent" | "unknown" required
    • id string required
    • privateNote boolean required
    • providerId null | string required
    • teamId string required
    • threadId string required
  • thread object required
    • assignment null | object required
      • assigned boolean required
      • mine boolean required
      • name null | string required
      • revision number required
    • createdAt string (date-time) required
    • id string required
    • requesterId string required
    • status "closed" | "open" required
    • subject string required
    • teamId string required
    • updatedAt string (date-time) required

support.list

List the workspace's support conversations with Shuffl

POST/api/v1/manage/support/list

const result = await shuffl.support.list({});
Request fields (1)
  • mine false | true optional
Response object[]
  • assignment null | object required
    • assigned boolean required
    • mine boolean required
    • name null | string required
    • revision number required
  • createdAt string (date-time) required
  • id string required
  • requesterId string required
  • status "closed" | "open" required
  • subject string required
  • teamId string required
  • updatedAt string (date-time) required

support.assign

Assign a Shuffl support conversation

POST/api/v1/manage/support/assign

const result = await shuffl.support.assign({
  "action": "claim",
  "expectedRevision": 0,
  "threadId": "<threadId>",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • action "claim" | "release" required
  • expectedRevision number required
  • threadId string required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • assignmentRevision number required
    • saved boolean required

support.close

Close a Shuffl support conversation

POST/api/v1/manage/support/close

const result = await shuffl.support.close({
  "closed": false,
  "threadId": "<threadId>",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • closed boolean required
  • threadId string required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • saved boolean required

support.create

Start a support conversation with Shuffl

POST/api/v1/manage/support/create

const result = await shuffl.support.create({
  "body": "<body>",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • body string required
  • guides "abstain" | "answer" | "empty" | "not_checked" | "unavailable" optional
  • subject string optional
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • assignment null | object required
      • assigned boolean required
      • mine boolean required
      • name null | string required
      • revision number required
    • createdAt string (date-time) required
    • id string required
    • requesterId string required
    • status "closed" | "open" required
    • subject string required
    • teamId string required
    • updatedAt string (date-time) required

support.reply

Reply in a Shuffl support conversation

POST/api/v1/manage/support/reply

const result = await shuffl.support.reply({
  "body": "<body>",
  "threadId": "<threadId>",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • body string required
  • messageId string optional
  • privateNote false | true optional
  • threadId string required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • authorId null | string required
    • authorRole "customer" | "email" | "operator" required
    • body string required
    • createdAt string (date-time) required
    • id string required
    • privateNote boolean required
    • providerId null | string required
    • teamId string required
    • threadId string required