Create or update an author
PUT/v1/authors/{external_id}Key scope write
Creates the author when the id is new and updates the properties sent. Use it to register an author before their first moderation, to attach your own metadata, or to pin a trust level.
Needs a key with the write scope. Authentication
Path parameters
external_idstringRequiredYour id for the end user. An id longer than 200 characters is cut to 200.
Request body
display_namestring or nullA name to show for the author in the dashboard, up to 200 characters. Null clears it. Omit it to leave it unchanged.
metadataobjectAn object of your own data, stored with the author. It replaces the stored object as a whole, so keys you leave out are removed.
trust_overrideenum or nullA trust level to pin:
new,basic,regular,establishedortrusted. While set, it is the author'strust_leveland content rules read it; the automatic level keeps being computed underneath. Null removes the override.One of
newbasicregularestablishedtrusted
Returns
The author, with status 200 whether it was created or updated. The body is optional: an empty request creates the author with default values. The author.trust_level_changed event is emitted when the effective trust level changed.
- 200 OKAn author object
Errors
- 422
validation_errorThe body has an unknown key,
display_nameis longer than 200 characters, ortrust_overrideis not a trust level.
Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors
Something missing or unclear on this page? Write to support@useinfrared.com.