itemsstringrequired
Comma-separated import id’s of a finalised file, as returned by the finalise call.
Example:00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000
Retrieve poll state
This call needs to be executed in a loop until its response returns the item(s) id(s) passed in the items parameter.
get
Query Parameters
Response
200 application/json
Response
200 application/json
Successful response
get/api/v4/upload/poll
Authentication
Query Parameters
200 application/json
Step 6 EITHER Save as a new asset
This endpoint finalizes the upload after all chunks have been uploaded. You need to provide the file ID and details about the file, including its name, size, and the number of chunks it was split into.
Save as a new asset
For metaproperties that use options (Select, Select2, Autocomplete), modifying an asset’s metaproperty options should be done via option UUID’s for the API to work optimally, sending name or label values will be deprecated in the future. Other metaproperties (Date, Text and Longtext), values can be submitted directly. Be aware that the endpoints described in Step 6 are an Either/Or choice. You should use either the Save as a new asset endpoint to save the uploaded file as a new asset, or the Update existing asset endpoint to update an existing asset with the uploaded file.
post
Path Parameters
importIdstringrequired
Import id of a finalised and processed upload to be saved.
Example:00000000-0000-0000-0000-000000000000
Headers
Content-Typestringrequired
Body
application/x-www-form-urlencoded
Body
application/x-www-form-urlencoded
ISOPublicationDatestring
Date/time of publication in ISO08601-format.
Example:2014-06-12T18:53:21.000Z
accessRequestIdstring
If audit is set to true you can specify an accessRequestId to batch uploads to the waiting room. The accessRequestId is retrieved in the response of this endpoint, after you save the first asset of your batch.
Example:00000000-0000-0000-0000000000000000
accessTypestring
If audit is set to true you can specify an access type to define to which waiting room location the asset is uploaded to. The available locations are: Upload, Edit, Workflow approval (export), Shutterstock and Stock.
Allowed values:uploadeditexportshutterstockstock
Example:upload
archiveDatestring
Archive date/time of the asset in ISO8601-format.
Example:2014-12-25T10:30:00.000Z
auditboolean
Flags if the asset should be sent to the waiting room.
Example:true
brandIdstringrequired
Brand id to save the asset to.
Example:00000000-0000-0000-0000-0000000000000000
categoriesstring
Comma-separated category ids of the asset.
Example:00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000
copyrightstring
Copyright information of the asset.
Example:Copyright (c) Example corp.
crc32integer
CRC32 checksum of the original file, used for verification.
Example:79764919
descriptionstring
Extended asset description.
Example:Extended asset description
isPublicboolean
Flags if the asset should be Public.
Example:true
metapropertystring
Dictionary with (metaproperty) options to set on the asset. Send fields as metaproperty.METAPROPERY_ID with a string of all its (metaproperty) options ids comma-separated.
Example:metaproperty.00000000-0000-0000-0000000000000000=00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000
namestring
Name of the asset.
Example:Asset name
publicationDatestring
DEPRECATED Date/time of publication in linked API user selected locale-format.
Example:05-31-2010
requestorIdstring
If audit is set to true you can specify a requestor ID (user ID) to identify the user uploading the asset to the waiting room.
Example:00000000-0000-0000-0000000000000000
tagsstring
Comma-separated list of tags of the asset.
Example:scenery,grassland,Holland
watermarkDatestring
Watermark datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.
Example:2014-12-25T10:30:00.000Z
Response
application/json
Response
application/json
Created
post/api/v4/media/save/{importId}
Authentication
Path Parameters
Headers
Body
{
"brandId": "00000000-0000-0000-0000-0000000000000000"
}
application/json
Save uploaded file to existing asset
Be aware that the endpoints described in Step 6 are an Either/Or choice. You should use either the Save as a new asset endpoint to save the uploaded file as a new asset, or the Update existing asset endpoint to update an existing asset with the uploaded file.
post
Path Parameters
idstringrequired
Asset id to which to save the uploaded file.
Example:00000000-0000-0000-0000-000000000000
importIdstringrequired
Import id of a finalised and processed upload to be saved.
Example:00000000-0000-0000-0000-000000000000
Body
text/plain
Body
text/plain
Response
201 application/json
Response
201 application/json
Created
post/api/v4/media/{id}/save/{importId}
Path Parameters
Body
{}
201 application/json
ApiUploadInitResponse
objectmultipart_paramsobject
Show Child Parameters
s3_filenamestring
Example:pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg
s3fileobject
Show Child Parameters
target_keystring
Example:pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg
Example