API reference / Docs
File, pin or archive a doc
Puts a doc in a folder (by its name, made when it is new) or unfiles it (null), pins it to the top of Docs, or archives it. An archived doc is out of Docs and out of search until it is restored (archived: false). None of these changes its text or its version.
/api/v1/docs/{slug}/placeOther ways to call it
troopy docs placetroopy_place_docIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Path parameters
slug*stringThe doc's id in the workspace, like acme-ltd
At most 80 characters
Body
application/jsonfolderstring | nullpinnedbooleanarchivedbooleanResponse
200 · application/jsondata*object16 properties
slug*stringkind*enum<string>What the doc is: a document (doc, brief, article, policy, decision, project, topic), a record about one person, company or product, an interview with a customer or an expert, or the report of a research
docbriefarticlepolicydecisionprojecttopicpersoncompanyproductinterviewresearch
title*stringversion*integerfolder*string | nullThe name of its folder; null when it is unfiled
pinned*booleanPinned to the top of Docs, for everyone
archived*booleanOut of Docs and out of search, until someone restores it
support*booleanThe Support Agent tells the visitors of the website what it says. Off until a person turns it on
properties*array<object>The values that it has of the properties of its collection, in their order
5 properties
id*stringThe id of the property: a write sends its value by this id
name*stringtype*enum<string>textnumberdateselectmulti_selecturlcheckbox
value*string | number | boolean | array<string> | nullThe value as it is kept: a select keeps the id of its option
text*stringThe value as people read it: the name of an option, a date, Yes
cover*string | nullThe first of its own images, on Troopy (it downloads with your key), or null
research*string | nullA report: the research that it answers (GET /research/{id})
createdBy*object | null3 properties
type*enum<string>personagentapi
id*stringname*stringupdatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
preview*stringThe start of its text, as plain words