v2
Docs
Create doc
post/v2/teams/{team_id}/docs
Path parameters
string uuid required
OR
string required
Request body
namestring required
Doc name
descriptionstring nullable
Optional description
slugstring nullable
Optional URL slug (must be unique within a team)
raw_yamlstring required
Raw YAML content (UTF-8)
is_publicboolean
Make doc public
is_pinnedboolean
Initialize a doc to being pinned for team
is_archivedboolean
Archive doc (soft delete)
permissionsobject nullable
Initial permissions for doc
Response
Success
namestring required
Doc name
descriptionstring nullable
Optional description
slugstring nullable
Optional URL slug (must be unique within a team)
raw_yamlstring required
Raw YAML content (UTF-8)
versioninteger
Version number
is_publicboolean
Doc is public (outside of team)
is_archivedboolean
Grave marker for soft deletion
created_atstring date-time
Doc created at
updated_atstring date-time
Doc updated at
permissionsobject
Permission mapping
is_pinnedboolean
Deprecated: use is_pinned_by_user instead
is_pinned_by_userboolean
Pinned by the requesting user
user_last_viewed_atstring date-time nullable
Last viewed by the requesting user
Changes
No recorded changes to this endpoint across all 1 revision of this API.