Skip to content

Import media from URLs on behalf of an installed app.

POST
/apps/media/imports
curl --request POST \
--url https://your-store.myciqra.com/apps/media/imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "urls": [ "example" ] }'

Required scope: write_media — an installation token without it receives 403.

Media typeapplication/json
object
urls
required
Array<string>
Examplegenerated
{
"urls": [
"example"
]
}

OK

Media typeapplication/json
object
failed
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
fetched
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
requested
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
results
required
Array<object>
object
assetUrl
required
null | string
error
required
null | string
errorCode
required
null | string
mediaAssetId
required
null | string format: uuid
status
required
string
url
required
string
succeeded
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
Examplegenerated
{
"failed": 1,
"fetched": 1,
"requested": 1,
"results": [
{
"assetUrl": "example",
"error": "example",
"errorCode": "example",
"mediaAssetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"status": "example",
"url": "example"
}
],
"succeeded": 1
}

Bad Request

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}