Supported Formats

json

Errors

Code Description
403 Forbidden - if you have Public Pool access only

Params

Param name Description
token
required

Token obtained from /authorize

Validations:

  • Must be String

id
required

ID of the Job Request

Validations:

  • Must be Integer

state
optional

Use 'cancelled' if you want cancel a job request.

Validations:

  • Must be String

job_request
required

A Job Request

Validations:

  • Must be a Hash

job_request[state]
required

The Job Request's status. See the Job Request resource documentation for details.

Validations:

  • Must be one of: unfilled, unassigned, posted, filled, in_progress, completed, approved, cancelled.

job_request[category]
required

The category of the work to be performed, e.g. 'Customer Service'. Must be one of the pre-defined values defined for the API user's Company.

Validations:

  • Must be String

job_request[description]
required

A detailed description of the work to be performed. Required unless description_tasks is specified. If the below description_ fields are specified, description will automatically be populated with a concatenation of those fields.

Validations:

  • Must be String

job_request[description_tasks]
required

A detailed description of the work to be performed. Required unless description is specified.

Validations:

  • Must be String

job_request[description_company]
optional

A description of the company making this Job Request.

Validations:

  • Must be String

job_request[description_travel]
optional

Travel tips for the Wonoloer in performing this Job Request.

Validations:

  • Must be String

job_request[description_skills]
optional

Skills required to satisfy this Job Request. Multiple skills should be separated with the pipe character +|+

Validations:

  • Must be String

job_request[description_contact]
optional

Who the Wonoloer should contact for any questions related to this Job Request.

Validations:

  • Must be String

job_request[description_arrival]
optional

Any arrival instructions for the Wonoloer.

Validations:

  • Must be String

job_request[slots]
required

The number of Wonoloers required.

Validations:

  • Must be Integer

job_request[start_time]
optional

The time to start work in 24-hour format. Example: 2018-08-18 19:30

Validations:

  • Must be DateTime

job_request[duration]
optional

The expected length of the Job in MINUTES.

Validations:

  • Must be Integer

job_request[venue]
optional

The name of the work location, e.g. 'Best Buy Store 321'

Validations:

  • Must be String

job_request[address]
required

The street address of the work location, e.g. '123 Fremont St'

Validations:

  • Must be String

job_request[city]
required

The city of the work location

Validations:

  • Must be String

job_request[zip]
required

The zip of the work location

Validations:

  • Must be String

job_request[employer_id]
optional

The ID of the Requestor (Employer) requesting the work

Validations:

  • Must be Integer

job_request[wage]
optional

The wage to be paid.

Validations:

  • Must be Float

job_request[request_name]
required

A Requestor-visible name for this Job Request (not visible to Wonoloer)

Validations:

  • Must be String

job_request[preferred_candidate_ids]
optional

An array of Wonoloer IDs that are Preferred for this Job Request. Preferred Wonoloers are notified first and have a chance to accept before other ranked Wonoloers are notified.

Validations:

  • Must be an array of Integer

job_request[open_request]
optional

True if this Job Request should open up to any eligible Wonoloer once all Preferred Wonoloers have been notified and a configurable time has passed

Validations:

  • Must be one of: true, false.

job_request[multi_day]
optional

True if this Job Request is part of a multi-day Job Request

Validations:

  • Must be one of: true, false.

job_request[multi_day_job_request_id]
optional

The id of the multi-day Job Request if multi-day

Validations:

  • Must be Integer

job_request[badge_requirements_attributes]
optional

Any Badges that are required to accept this Job Request

Validations:

  • Must be an Array of nested elements

job_request[badge_requirements_attributes][badge_id]
required

The ID of the Badge that is required

Validations:

  • Must be Integer

job_request[notification_distance]
optional

The maximum distance in MILES for notifications for this Job Request. Wonoloers whose current location is more than this distance from the Job Request location will not be notified. Overrides any default setting at the Company level.

Validations:

  • Must be Integer

job_request[ban_list]
optional

An array of Wonoloer IDs that are explicitly blocked from being notified or accepting this Job Request.

Validations:

  • Must be an array of Integer

job_request[classification]
optional

The Job Request's tax classification. Default is 1099.

Validations:

  • Must be one of: w2, 1099.

job_request[w2_hourly_rate]
optional

The hourly rate for W2 job requests — required with W2 classification

Validations:

  • Must be Float

job_request[push_all_notifications_asap]
optional

Send all push notifications asap - use 'on' to set, 'off' to unset

Validations:

  • Must be String

job_request[can]
optional

Company defined job request number

Validations:

  • Must be String

job_request[agent_code]
optional

Company defined employee number - must be between 1 and 25 characters in length

Validations:

  • Must be String

job_request[organizational_path]
optional

Company defined notification tiers

Validations:

  • Must be String