FIfieldguide
engagements
files

Upload a File to the specified Engagement

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

Request

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

Path parameters

uuidstring uuid required

The UUID of the Engagement to upload the File to

Request body multipart/form-data

filestring binary required
folder_uuidstring uuid

The Folder UUID of the Engagement this File is associated with

Response

The UUID of the File that was attached to the Engagement

Example response

{
  "data": {
    "name": "Board of Directors.docx",
    "size": 137437,
    "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "url": "https://example.com/document.docx",
    "url_expiration": "2023-01-01T12:30:00.000Z",
    "uuid": "91aeda5e-4a3c-4090-90b1-cbf09d4c1ba1",
    "created_at": "2023-01-01T12:30:00.000Z",
    "updated_at": "2023-01-01T12:30:00.000Z",
    "_links": {
      "fieldguide": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}

Changes