Support Messages

List support messages for document

OAuth: This endpoint requires one of the following scopes: discussion:manage, discussion:read or discussion:write.

List Support Messages

GEThttps://api.textmaster.com/v1/clients/projects/{project_id}/documents/{document_id}/support_messages

Authorization

oauth2

Path parameters

project_id*string

Project ID

document_id*string

Document ID

Response

200401403

Lists support Messages

Body

application/json

support_messagesarray of SupportMessage (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/documents/{document_id}/support_messages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "support_messages": [
    {
      "content": "text",
      "message": "text",
      "author_id": "text",
      "written_by_you": false,
      "written_by_author": false,
      "author_ref": "text",
      "created_at": {
        "full": "text"
      }
    }
  ]
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/projects/61698af88b81926d91c0f514/documents/61698af88b81926d91c0f515/support_messages" \
  -H "Authorization: Bearer c5b2a822f9f3e2914e7056b7089503cd1be33ab9bdb4313403341a315c7dbacf"

Create a support message

Creates a support message for given a document in_review, or creates a reply to an existing message from the author when the document is in_progress.

OAuth: This endpoint requires one of the following scopes: discussion:manage or discussion:write.

Create a Support Message

POSThttps://api.textmaster.com/v1/clients/projects/{project_id}/documents/{document_id}/support_messages

Authorization

oauth2

Path parameters

project_id*string

Project ID

document_id*string

Document ID

Body

application/json

support_message*object

revision_requestboolean

Only used when document status in 'in_review'. If 'true' (default), this support message is considered a revision request and the document is transitioned back to the 'incomplete' status so that the author can continue working on it.

Response

200401403

Lists support Messages

Body

application/json

content*string

message*string

author_id*string

written_by_you*boolean

written_by_author*boolean

author_ref*string

created_at*Date (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/documents/{document_id}/support_messages', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "support_message": {
        "message": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "content": "text",
  "message": "text",
  "author_id": "text",
  "written_by_you": false,
  "written_by_author": false,
  "author_ref": "text",
  "created_at": {
    "full": "text"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698afa8b81926d91c0f5a8/documents/61698afa8b81926d91c0f5a9/support_messages" \
  -X POST \
  -d '{
    "support_message": {
      "message": "Some message explaining why a revision is requested."
    },
    "revision_request": true
  }' \
  -H "Authorization: Bearer 44c90f771334393a72a9b3135711a603d4856e499d96ba5ffaac5e1ab55b21bd" \
  -H "Content-Type: application/json"