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.
The category of authors to list (lists all by default).
Prossible values:
- preferred
- blacklisted
- uncategorized
- my_textmaster (legacy, prefer 'preferred')
Search results are limited to 100 items. Specify page number to read more than the first page.
Number of items per page. Default is 100. Maximum is 100.
Lists My Authors
Unauthorized
Forbidden
GET /v1/clients/my_authors HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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"
}
}
]
}
Code samples
curl -G "https://api.textmaster.com/v1/clients/my_authors" \
-H "Authorization: Bearer 790d0c6d24747b818f1c83184a2720e603db74b0b7de246365636765569c5d4e"
Add a preferred author
My Author Created
Unauthorized
Forbidden
Unprocessable Entity
POST /v1/clients/my_authors HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110
{
"my_author": {
"author_id": "61698ab08b81926d91c0e8a3",
"description": "Some personal note",
"status": "preferred"
}
}
{
"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"
}
}
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
(required) ID of the Author
Gets My Author Info
Unauthorized
Forbidden
My Author Info Not Found
GET /v1/clients/my_authors/{author_id} HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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"
}
}
Code samples
curl -G "https://api.textmaster.com/v1/clients/my_authors/61698ab08b81926d91c0e8a3" \
-H "Authorization: Bearer f2a5e17102ca9e6c8494b323847b784615ab1da0f1525258d85af89385fef5f5"
Update a preferred author
(required) ID of the Author
My Author Updated
Unauthorized
Forbidden
My Author Info Not Found
Unprocessable Entity
PUT /v1/clients/my_authors/{author_id} HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"my_author": {
"description": "Updated personal note",
"status": "preferred"
}
}
{
"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"
}
}
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
The Project ID.
The category of authors to list (lists all by default).
Prossible values:
- preferred
- blacklisted
- uncategorized
- my_textmaster (legacy, prefer 'preferred')
Search results are limited to 100 items. Specify page number to read more than the first page.
Lists possible My Authors
Unauthorized
Forbidden
GET /v1/clients/projects/{project_id}/my_authors HTTP/1.1
Host: api.textmaster.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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"
}
}
]
}
Code samples
curl -G "https://api.textmaster.com/v1/clients/projects/61698ab18b81926d91c0e8e7/my_authors" \
-H "Authorization: Bearer 2a1e347c6aaf1515cbb7e146601e93832359d4edc437e0d494ed195facccc05d"
Last updated
Was this helpful?