Preferred Authors

Last updated 1 year ago

Was this helpful?

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.

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.

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.

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.

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.

Code samples

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

PreviousLocales NextProjects

Last updated 1 year ago

Was this helpful?

List preferred authors

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

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.

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.

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.

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.

Code samples

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

Get My Authors

get

/v1/clients/my_authors

Authorizations

Query parameters

statusstring · enum

The category of authors to list (lists all by default).

Prossible values:

preferred
blacklisted
uncategorized
my_textmaster (legacy, prefer 'preferred')

Options: preferred, blacklisted, uncategorized, my_textmaster

pageinteger

Search results are limited to 100 items. Specify page number to read more than the first page.

per_pageinteger

Number of items per page. Default is 100. Maximum is 100.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.textmaster.com/v1/clients/my_authors'

200

401

403

{
  "total_pages": 1,
  "count": 1,
  "page": 1,
  "per_page": 100,
  "previous_page": null,
  "next_page": null,
  "my_authors": [
    {
      "id": "61698aaf8b81926d91c0e87a",
      "author_id": "61698aaf8b81926d91c0e86f",
      "author_name": "john",
      "author_ref": "A-986F-FM",
      "created_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:05:35 UTC"
      },
      "description": "description",
      "latest_activity": "2021-10-15 14:05:06 UTC",
      "status": "preferred",
      "tags": [],
      "updated_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:05:35 UTC"
      }
    }
  ]
}

Lists My Authors

Add a My Author

post

/v1/clients/my_authors

Authorizations

Body

my_authorobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.textmaster.com/v1/clients/my_authors' \
  --header 'Content-Type: application/json' \
  --data '{
    "my_author": {
      "author_id": "61698ab08b81926d91c0e8a3",
      "description": "Some personal note",
      "status": "preferred"
    }
  }'

200

401

403

422

{
  "id": "61698ab08b81926d91c0e8ae",
  "author_id": "61698ab08b81926d91c0e8a3",
  "author_name": "john",
  "author_ref": "A-98A3-FM",
  "created_at": {
    "day": 15,
    "month": 10,
    "year": 2021,
    "full": "2021-10-15 14:05:36 UTC"
  },
  "description": "Some personal note",
  "latest_activity": "2021-10-15 14:05:06 UTC",
  "status": "preferred",
  "tags": [],
  "updated_at": {
    "day": 15,
    "month": 10,
    "year": 2021,
    "full": "2021-10-15 14:05:36 UTC"
  }
}

My Author Created

Retrieve a single My Author

get

/v1/clients/my_authors/{author_id}

Authorizations

Path parameters

author_idstringrequired

(required) ID of the Author

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.textmaster.com/v1/clients/my_authors/{author_id}'

200

401

403

404

{
  "id": "61698ab08b81926d91c0e8ae",
  "author_id": "61698ab08b81926d91c0e8a3",
  "author_name": "john",
  "author_ref": "A-98A3-FM",
  "created_at": {
    "day": 15,
    "month": 10,
    "year": 2021,
    "full": "2021-10-15 14:05:36 UTC"
  },
  "description": "description",
  "latest_activity": "2021-10-15 14:05:06 UTC",
  "status": "preferred",
  "tags": [],
  "updated_at": {
    "day": 15,
    "month": 10,
    "year": 2021,
    "full": "2021-10-15 14:05:36 UTC"
  }
}

Gets My Author Info

Update My Author

put

/v1/clients/my_authors/{author_id}

Authorizations

Path parameters

author_idstringrequired

(required) ID of the Author

Body

my_authorobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.textmaster.com/v1/clients/my_authors/{author_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "my_author": {
      "description": "Updated personal note",
      "status": "preferred"
    }
  }'

200

401

403

404

422

{
  "id": "61698ab08b81926d91c0e8ae",
  "author_id": "61698ab08b81926d91c0e8a3",
  "author_name": "john",
  "author_ref": "A-98A3-FM",
  "created_at": {
    "day": 15,
    "month": 10,
    "year": 2021,
    "full": "2021-10-15 14:05:36 UTC"
  },
  "description": "description",
  "latest_activity": "2021-10-15 14:05:06 UTC",
  "status": "my_textmaster",
  "tags": [],
  "updated_at": {
    "day": 15,
    "month": 10,
    "year": 2021,
    "full": "2021-10-15 14:05:36 UTC"
  }
}

My Author Updated

Get all My Authors who can do a given Project

get

/v1/clients/projects/{project_id}/my_authors

Authorizations

Path parameters

project_idstringrequired

The Project ID.

Query parameters

statusstring · enum

The category of authors to list (lists all by default).

Prossible values:

preferred
blacklisted
uncategorized
my_textmaster (legacy, prefer 'preferred')

Options: preferred, blacklisted, uncategorized, my_textmaster

pageinteger

Search results are limited to 100 items. Specify page number to read more than the first page.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.textmaster.com/v1/clients/projects/{project_id}/my_authors'

200

401

403

{
  "total_pages": 1,
  "count": 1,
  "page": 1,
  "per_page": 20,
  "previous_page": null,
  "next_page": null,
  "my_authors": [
    {
      "id": "61698aaf8b81926d91c0e87a",
      "author_id": "61698aaf8b81926d91c0e86f",
      "author_name": "john",
      "author_ref": "A-986F-FM",
      "created_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:05:35 UTC"
      },
      "description": "description",
      "latest_activity": "2021-10-15 14:05:06 UTC",
      "status": "preferred",
      "tags": [],
      "updated_at": {
        "day": 15,
        "month": 10,
        "year": 2021,
        "full": "2021-10-15 14:05:35 UTC"
      }
    }
  ]
}

Lists possible My Authors

List preferred authors

Code samples

Add a preferred author

Code samples

Get a preferred author

Code samples

Update a preferred author

Code samples

List preferred authors able to work on project

Code samples

List preferred authors

Code samples

Add a preferred author

Code samples

Get a preferred author

Code samples

Update a preferred author

Code samples

List preferred authors able to work on project

Code samples

Get My Authors

Add a My Author

Show child attributes

Retrieve a single My Author

Update My Author

Show child attributes

Get all My Authors who can do a given Project