--- title: "Attach uploaded media" method: POST path: "/v1/property_claims/{property_claim_id}/media" tags: ["Property Claim"] --- # Attach uploaded media `POST /v1/property_claims/{property_claim_id}/media` ## Headers - `X-Encircle-Attribution` string - `X-Encircle-Request` string ## Request body - MediaRequest — Pictures, documents, and other media uploaded under a specific Encircle file. - `upload_id` string, uuid, required — Used for attaching media to an object. They are created via `POST` `/upload` and expire after 24 hours since being issued. A [RFC 4122](https://tools.ietf.org/html/rfc4122#section-3) compliant UUID in lowercase hexadecimal. - `filename` string, required — Suggested filename for this media file. - `content_type` string, required — The MIME type of this media file. ## Response `200` The `Media` was attached successfully. - MediaResponse — Pictures, documents, and other media uploaded under a specific Encircle file. - `filename` string, required — Suggested filename for this media file. - `content_type` string, required — The MIME type of this media file. - `download_uri` string, required — A URI that can be used to download this media file. Download links are valid for 24 hours. - `labels` string[], required - `creator` ActorResponse, required - `actor_type` 'User', required - `actor_identifier` string, required — A string that identifies the actor. The identifier is an email address when the `actor_type` is `User`. - `primary_server_created` string, date-time, required — `primary` refers to the initial media creation. `server_created` is the timestamp at which Encircle servers created the model. It is typically later than the `client_created` timestamp (unless the client had provided an inaccurate timestamp). This unbounded delay depends on how long the client took to sync with the server. The Encircle mobile app allows users to work offline, which means that a client can create a model, wait a day, then go online and sync with Encircle servers. The server's timestamp would be delayed by about a day after the model's creation on the client. Refer to `client_created` for the client provided timestamp. A [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6) compliant `date-time` string. - `primary_client_created` string, date-time, nullable, required — `primary` refers to the initial media creation. `client_created` is the timestamp at which a user's client created the model. It is typically earlier than the `server_created` timestamp, but since this timestamp is provided by the client and not verified, it could have been altered to any time in the past or future. The Encircle mobile app allows users to work offline. This timestamp captures the time that the model was created locally, regardless of when the client goes back online. Encircle web and mobile applications typically display the earlier of the `client_created` and `server_created` timestamps. Refer to `server_created` for the timestamp recorded by Encircle servers. A [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6) compliant `date-time` string. - `secondary_server_created` string, date-time — `secondary` refers to each time the same media is generated or edited. It only exists on report and export media. `server_created` is the timestamp at which Encircle servers created the model. It is typically later than the `client_created` timestamp (unless the client had provided an inaccurate timestamp). This unbounded delay depends on how long the client took to sync with the server. The Encircle mobile app allows users to work offline, which means that a client can create a model, wait a day, then go online and sync with Encircle servers. The server's timestamp would be delayed by about a day after the model's creation on the client. Refer to `client_created` for the client provided timestamp. A [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6) compliant `date-time` string. - `secondary_client_created` string, date-time, nullable — `secondary` refers to each time the same media is generated or edited. It only exists on report and export media. `client_created` is the timestamp at which a user's client created the model. It is typically earlier than the `server_created` timestamp, but since this timestamp is provided by the client and not verified, it could have been altered to any time in the past or future. The Encircle mobile app allows users to work offline. This timestamp captures the time that the model was created locally, regardless of when the client goes back online. Encircle web and mobile applications typically display the earlier of the `client_created` and `server_created` timestamps. Refer to `server_created` for the timestamp recorded by Encircle servers. A [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6) compliant `date-time` string. - `source` MediaSourceResponse, required — Information about the model of the media (type and IDs) - `type` string, required — The type of the media. The list of types below is not complete. We reserve the right to add more values under this property as the data model evolves | Type |   | Description | | ---- |-| ----------- | | ClaimRoomAfterPicture | | Property claim room overview photos | | RoomPicture | | Property inspection room overview photos | | ClaimPdfReport | | Encircle PDF report for property claim | | PropertyClaimDocumentValue | | Encircle custom forms for property claim | | ClaimRoomPictureNotePicture | | Property claim room photo note photos | | ClaimSketch | | Property claim room sketch | | ClaimSketchBackground | | Property claim room sketch background photos | | ClaimSketchPictureNodePicture | | Property claim room sketch photos | | ClaimBlobDocument | | Property claim uploaded documents | | ClaimPictureDocument | | Property claim scanned documents | | ClaimExcelReport | | Property claim excel reports | | ClaimMediaExport | | Property claim media exports | | VideoFile | | Room overview videos for property claim or property inspection | |   | | | - `primary_id` string, required — The ID of the media, it can be a UUID or a number in string form. - `secondary_id` string — Similar to the primary ID, but optional. This ID only exists on report models. Each time the report is edited and saved, the secondary ID will be different. ## Other responses - `400` — Error processing request. - `401` — Authentication error. - `404` — Requested resource does not exist. --- [API](https://skmtc.net/encircleapp/apis/encircle-public-api.md) · [All operations](https://skmtc.net/encircleapp/apis/encircle-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/encircleapp/encircle-public-api/revisions/0e70222a2c6d/schema)