# Documents API

The Meeting Documents APIs can be used to add shareable documents to a meeting. These documents are be made available to a meeting's members to view and download.

# Meeting Documents Endpoints

# Add a meeting document

Add a document to a meeting

POST /Meetings/{shortCode}/documents

# Path Params

Property	Type	Description
shortCode	string	The meeting's unique short code

# Request

{
  "Key": "/filekey.pdf",
  "name": "filename.pdf",
  "size": 100000
}

Property	Type	Description
Key	string	Location of the document
name	string	Name of the file
size	number	File size in bytes

# Response

[
  {
    "key": "58a0ff38-5eea-41c9-a7c3-af54968c2476",
    "document": {
      "Key": "/filekey.pdf",
      "name": "filename.pdf",
      "size": 100000,
      "url": "https://s3.aws.com......."
    },
    "createdAt": "2018-02-22T19:05:04.931Z",
    "updatedAt": "2018-02-22T19:05:04.931Z"
  }
]

Description:

(WIP))

# Get a meeting document

Get the document for a meeting

GET /Meetings/{shortCode}/documents/{documentKey}

# Path Params

Property	Type	Description
shortCode	string	The meeting's unique short code
documentKey	string	The UUID of the document to retrieve

# Response

[
  {
    "key": "58a0ff38-5eea-41c9-a7c3-af54968c2476",
    "document": {
      "Key": "/filekey.pdf",
      "name": "filename.pdf",
      "size": 100000,
      "url": "https://s3.aws.com......."
    },
    "createdAt": "2018-02-22T19:05:04.931Z",
    "updatedAt": "2018-02-22T19:05:04.931Z"
  }
]

Description:

(WIP))

# Delete a meeting document

Delete the document for a meeting

DELETE /Meetings/{shortCode}/documents/{documentKey}

# Path Params

Property	Type	Description
shortCode	string	The meeting's unique short code
documentKey	string	The UUID of the document to retrieve

# Response

204 No Content

← Meetings API Voting Matters API →