Import media
Imports media by URL and attaches it to a parent resource. Requires the Media create permission and update rights on the target. Deduplicates (see the Media tag), so repeating a request is safe. For many items use POST /api/v2/media/batch. When the import lands on an existing shared asset, `attachments` in the response lists only the placements the caller can view.
/api/v2/mediaImports media by URL and attaches it to a parent resource. Requires the Media create permission and update rights on the target. Deduplicates (see the Media tag), so repeating a request is safe. For many items use POST /api/v2/media/batch. When the import lands on an existing shared asset, attachments in the response lists only the placements the caller can view.
Authorization
bearerAuth In: header
Query Parameters
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.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/media" \ -H "Content-Type: application/json" \ -d '{ "kind": "file", "url": "http://example.com", "attachable_type": "property", "attachable_id": "59195f01-f1b9-4338-a5d0-42410c1862ca", "media_type": "image" }'{ "data": { "kind": "file", "media": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "url": "string", "thumb_url": "string", "full_url": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ], "reference_url": "string", "reference_id": "string", "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5", "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901" }, "attachments": [ { "attachable_type": "property", "attachable_id": "59195f01-f1b9-4338-a5d0-42410c1862ca", "slot": "string", "sort_order": 0 } ] }}