Editing Jobs

Create an editing job

Creates an editing job. There are two ways to create one:

  1. Provide the source images.
  2. Set images to null and provide uploader_firstname and uploader_email. Snappr contacts the third-party uploader to collect the images.
post/editing-jobs

Request

  • Base URL
    https://api.snappr.com
  • URL
    https://api.snappr.com/editing-jobs
  • Auth
    HTTP bearer

Headers

accept-versionstring

API version. The only version is 1.0.0.

Request body

titlestring

Custom editing job title.

typestring required

Editing job type name (see listEditingJobTypes), e.g. food.

preset_idstring uuid required

Preset uid (see listPresets).

internal_idstring

Your own identifier, for matching the job with your data.

uploader_firstnamestring
uploader_surnamestring
uploader_emailstring email
uploader_mobilephonestring
uploader_companystring
min_photo_numberinteger

Minimum number of photos the third-party uploader must upload.

max_photo_numberinteger

Maximum number of photos the third-party uploader may upload. Must be greater than min_photo_number.

Response

Editing job created. Credits are charged after the response. If images were sent in the body and the account doesn't have enough credits, the job's status becomes failed. If images was null, the job stays pending_upload until it can be paid.

uidstring uuid required
titlestring nullable
statusstring required

Editing job status, e.g. creating, pending_upload, editing, completed, failed.

typestring required
creditsnumber nullable

Credits charged, once paid.

preset_idstring uuid nullable
uploader_firstnamestring nullable
uploader_surnamestring nullable
uploader_emailstring nullable
uploader_mobilephonestring nullable
uploader_companystring nullable
min_photo_numberinteger nullable
max_photo_numberinteger nullable
internal_idstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.