Docs
V2 APIMedia

Remove a file from a record

Takes the file off one record. The file stays in the media library and on every other record. Embeds belong to one record: delete the embed instead.

DELETE/api/v2/media/{media}/attachments/{attachableType}/{attachableId}

Takes the file off one record. The file stays in the media library and on every other record. Embeds belong to one record: delete the embed instead.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

media*string

The file's id.

Formatuuid
attachableType*string

The kind of record the file is on.

Value in

  • "property"
  • "unit"
  • "building"
  • "floor_plan"
  • "gallery"
  • "amenity"
  • "announcement"
  • "neighborhood_place"
  • "content_block"
  • "content_item"
attachableId*string

The record's id.

Formatuuid

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid
slot?string

Only the placement in this slot (for example image or background_image), when the file is on the record more than once.

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v2/media/497f6eca-6276-4993-bfeb-53cbbbba6f08/attachments/property/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty