Preferred Authors

List preferred authors

By default, you can only list preferred authors which have been whitelisted or blacklisted. Preferred authors who completed a document of yours but you didn't rate can be found within the uncategorized list.

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

Get My Authors

GEThttps://api.textmaster.com/v1/clients/my_authors

Authorization

oauth2

Query parameters

Response

200401403

Lists My Authors

Body

application/json

total_pagesinteger

countinteger

pageinteger

per_pageinteger

previous_pagenullable integer

next_pagenullable integer

my_authorsarray of MyAuthor (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "my_authors": [
    {
      "id": "text",
      "author_id": "text",
      "author_name": "text",
      "author_ref": "text",
      "created_at": {
        "full": "text"
      },
      "description": "text",
      "latest_activity": "text",
      "status": "text",
      "tags": [
        "text"
      ],
      "updated_at": {
        "full": "text"
      }
    }
  ]
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/my_authors" \
  -H "Authorization: Bearer 790d0c6d24747b818f1c83184a2720e603db74b0b7de246365636765569c5d4e"

Add a preferred author

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

Add a My Author

POSThttps://api.textmaster.com/v1/clients/my_authors

Authorization

oauth2

Body

application/json

my_author*object

Response

200401403422

My Author Created

Body

application/json

idstring

author_idstring

author_namestring

author_refstring

created_atDate (object)

descriptionnullable string

latest_activitystring

statusstring

tagsarray of string

updated_atDate (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.textmaster.com/v1/clients/my_authors', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "my_author": {
        "author_id": "61698ab08b81926d91c0e8a3",
        "status": "preferred"
      }
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "author_id": "text",
  "author_name": "text",
  "author_ref": "text",
  "created_at": {
    "full": "text"
  },
  "description": "text",
  "latest_activity": "text",
  "status": "text",
  "tags": [
    "text"
  ],
  "updated_at": {
    "full": "text"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/my_authors" \
  -X POST \
  -d '{
    "my_author": {
      "description": "Some description",
      "status": "my_textmaster",
      "author_id": "61698aaf8b81926d91c0e889"
    }
  }' \
  -H "Authorization: Bearer 3a7dce3b773247c159b8f18be707c2c5838d2e7138d36813e74e28e43caa0aaa" \
  -H "Content-Type: application/json"

Get a preferred author

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

Retrieve a single My Author

GEThttps://api.textmaster.com/v1/clients/my_authors/{author_id}

Authorization

oauth2

Path parameters

author_id*string

(required) ID of the Author

Response

200401403404

Gets My Author Info

Body

application/json

idstring

author_idstring

author_namestring

author_refstring

created_atDate (object)

descriptionnullable string

latest_activitystring

statusstring

tagsarray of string

updated_atDate (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.textmaster.com/v1/clients/my_authors/{author_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "author_id": "text",
  "author_name": "text",
  "author_ref": "text",
  "created_at": {
    "full": "text"
  },
  "description": "text",
  "latest_activity": "text",
  "status": "text",
  "tags": [
    "text"
  ],
  "updated_at": {
    "full": "text"
  }
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/my_authors/61698ab08b81926d91c0e8a3" \
  -H "Authorization: Bearer f2a5e17102ca9e6c8494b323847b784615ab1da0f1525258d85af89385fef5f5"

Update a preferred author

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

Update My Author

PUThttps://api.textmaster.com/v1/clients/my_authors/{author_id}

Authorization

oauth2

Path parameters

author_id*string

(required) ID of the Author

Body

application/json

my_author*object

Response

200401403404422

My Author Updated

Body

application/json

idstring

author_idstring

author_namestring

author_refstring

created_atDate (object)

descriptionnullable string

latest_activitystring

statusstring

tagsarray of string

updated_atDate (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.textmaster.com/v1/clients/my_authors/{author_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "my_author": {
        "status": "preferred"
      }
    }),
});
const data = await response.json();

Response

200404422

{
  "id": "text",
  "author_id": "text",
  "author_name": "text",
  "author_ref": "text",
  "created_at": {
    "full": "text"
  },
  "description": "text",
  "latest_activity": "text",
  "status": "text",
  "tags": [
    "text"
  ],
  "updated_at": {
    "full": "text"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/my_authors/61698ab08b81926d91c0e8bd" \
  -X PUT \
  -d '{ "my_author": { "description": "Some new description" } }' \
  -H "Authorization: Bearer b9ad70843ca9d09f59bc27f87c1aab02de0dfd03109ca1a7a3f70f899f6427c6" \
  -H "Content-Type: application/json"

List preferred authors able to work on project

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

Get all My Authors who can do a given Project

GEThttps://api.textmaster.com/v1/clients/projects/{project_id}/my_authors

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Query parameters

Response

200401403

Lists possible My Authors

Body

application/json

total_pagesinteger

countinteger

pageinteger

per_pageinteger

previous_pagenullable integer

next_pagenullable integer

my_authorsarray of MyAuthor (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "my_authors": [
    {
      "id": "text",
      "author_id": "text",
      "author_name": "text",
      "author_ref": "text",
      "created_at": {
        "full": "text"
      },
      "description": "text",
      "latest_activity": "text",
      "status": "text",
      "tags": [
        "text"
      ],
      "updated_at": {
        "full": "text"
      }
    }
  ]
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/projects/61698ab18b81926d91c0e8e7/my_authors" \
  -H "Authorization: Bearer 2a1e347c6aaf1515cbb7e146601e93832359d4edc437e0d494ed195facccc05d"