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

get

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Path parameters

project_idstringRequired

Project ID

document_idstringRequired

Document ID

Responses

200

Lists support Messages

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

get/v1/clients/projects/{project_id}/documents/{document_id}/support_messages

GET /v1/clients/projects/{project_id}/documents/{document_id}/support_messages HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "support_messages": [
    {
      "content": "Hey, we need a small fix there",
      "message": "Hey, we need a small fix there",
      "author_id": "61698af88b81926d91c0f50e",
      "written_by_you": true,
      "written_by_author": false,
      "author_ref": "C-980E-FM",
      "created_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:06:50 UTC"
      }
    },
    {
      "content": "done",
      "message": "done",
      "author_id": "61698afa8b81926d91c0f58e",
      "written_by_you": false,
      "written_by_author": true,
      "author_ref": "A-988E-FM",
      "created_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:06:50 UTC"
      }
    }
  ]
}

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

post

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2authorizationCodeRequired

OAuth2 Bearer token authentication

Authorization URL: Token URL: Refresh URL:

Path parameters

project_idstringRequired

Project ID

document_idstringRequired

Document ID

Body

revision_requestbooleanOptional

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.

Responses

200

Lists support Messages

application/json

contentstringRequired

messagestringRequired

author_idstringRequired

written_by_youbooleanRequired

written_by_authorbooleanRequired

author_refstringRequired

401

Unauthorized

application/json

403

Forbidden

application/json

post/v1/clients/projects/{project_id}/documents/{document_id}/support_messages

POST /v1/clients/projects/{project_id}/documents/{document_id}/support_messages HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "support_message": {
    "message": "text"
  },
  "revision_request": true
}

{
  "content": "we need a fix here",
  "message": "we need a fix here",
  "author_id": "61698afa8b81926d91c0f5a2",
  "written_by_you": true,
  "written_by_author": false,
  "author_ref": "C-98A2-FM",
  "created_at": {
    "day": 15,
    "month": 10,
    "year": 2021,
    "full": "2021-10-15 14:06:52 UTC"
  }
}

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"