FIfieldguide
engagements
files

Create a Folder in the specified Engagement

Changed on
post/v1/engagements/{uuid}/folders

Request

  • Base URL
    https://api.fieldguide.io
  • URL
    https://api.fieldguide.io/v1/engagements/{uuid}/folders
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

The UUID of the Engagement in which to create a Folder

Request body

namestring required

The Folder name. Slashes are not allowed.

parent_folder_uuidstring uuid nullable

Parent Folder UUID. Omit or set to null for a root Folder.

Example request

{
  "name": "Documents"
}

Response

The newly created Engagement Folder

Example response

{
  "data": {
    "uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "parent_folder_uuid": "721e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "engagement_uuid": "921e8d9e-d2a8-480f-9187-5a685d3d0d71",
    "name": "Documents",
    "path": "/grandparent/parent",
    "created_at": "2024-03-19T12:00:00Z",
    "_links": {
      "fieldguide": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}

Changes