Crop uploaded File (since 1.0.17)

GET https://[subdomain].speakap.com/files/:eid/crop

Request

URI:/files/{messageEID}/crop
Method:POST
Accept:application/vnd.speakap.api-v1.8.2+json+hal
Authentication:OAuth 2.0

Parameters

Name Type Description
messageEID EID EID of a file type message

Request body

Content-Type:application/x-www-form-urlencoded
Name Type Description
type string Image file type
x number Horizontal position in integer pixels of left edge of crop rectangle
y number Vertical position in integer pixels of top edge of crop rectangle
width number Width of the crop rectange in integer pixels
height number Height of the crop rectange in integer pixels

Response

201
Returns a binary file
400
File cannot be cropped: returns an Error object
403
Unauthorized: returns an Error object
404
Unknown file message or network: returns an Error object