SNsnappr
Magic Jobs

Create a Magic Job

Creates a Magic Job. It is returned with status created; Snappr then locates the business's listing, generates the images and delivers them in one or more batches. Each delivery triggers an images_delivered webhook event.

post/magic-jobs

Request

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

Headers

accept-versionstring

API version. The only version is 1.0.0.

Request body

type'menu' required

Type of Magic Job.

restaurant_namestring

Name of the restaurant as it appears on your platform. Required when type is menu.

restaurant_addressstring

Full address of the restaurant as a single string. Required when type is menu.

internal_idstring

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

source_urlstring uri

URL of the restaurant's store page on your platform. If omitted, Snappr locates it from the name, address and internal_id.

Response

Magic Job created.

uidstring uuid required
type'menu' required
status'created' | 'in_progress' | 'completed' | 'failed' required
completed_atstring date-time nullable
restaurant_namestring nullable
restaurant_addressstring nullable
source_platformstring nullable

Platform Snappr found the listing on.

source_urlstring uri nullable
internal_idstring nullable
images_countinteger

Number of delivered images. Present only when status is completed.

created_atstring date-time
updated_atstring date-time

Changes

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