STstreet
Documents

Create a Document

Changed on

This endpoint allows you to create a Document attached to an entity by providing a publically accessible URL for the file. In addition you can add relevant information such as a title and description of the file.

post/documents

Request

Request body

Example request

{
  "data": {
    "attributes": {
      "key": "api_tenancy_guide"
    }
  }
}

Response

Created.

Example response

{
  "data": {
    "attributes": {
      "name": "p045126_01",
      "order": 1,
      "collection": "general",
      "url": "https://ik.imagekit.io/street/street-live/properties/general/787110/p045126_01.jpg"
    }
  }
}

Changes