Upload a photo chunk

PATCH

/cms/photo/{file_id}

const url = 'https://api.example.com/cms/photo/example';
const options = {
  method: 'PATCH',
  headers: {'Upload-Offset': '1', 'Upload-Length': '1', 'Upload-Name': 'example'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.example.com/cms/photo/example \
  --header 'Upload-Length: 1' \
  --header 'Upload-Name: example' \
  --header 'Upload-Offset: 1'

Uploads a chunk for a photo and assembles the file when complete. Max recommended chunk size is 10MB. When the upload is complete, the response will contain the details of the uploaded photo in JSON format. If the upload is still in progress, the response will contain the current filename being uploaded.

Parameters

Path Parameters

file_id

required

string

File ID returned from the create endpoint

Header Parameters

Upload-Offset

required

integer

Byte offset for the chunk being uploaded

Upload-Length

required

integer

Total byte length of the file being uploaded

Upload-Name

required

string

Original filename of the uploaded file

Request Body^required

application/octet-stream

Responses

200

Chunk accepted or upload complete

application/json

One of:

object
Attachment

Chunk accepted, upload in progress

object

filename

string

Example ^generated

{
  "filename": "example"
}

400

Invalid upload headers

Upload a photo chunk

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

200

Example generated

400

Request Body^required

Example ^generated