Features API

Overview

This section provides API specification for adding optional Features to an existing job. Features are paid add-ons that enhance the distribution of a job.

Authentication

This API uses Basic authentication. Include your API key in the Authorization header of every request.

The Features Model

The Features model is represented as a JSON object in the request or response body.

Features model fields

Field	Required	Type	Description
features	Yes	object	Contains the features to apply to a job.
features.trafficboost	Yes	string	The TrafficBoost level to apply. One of: single, double, triple.

Available Features

TrafficBoost

TrafficBoost provides increased placement for your job on ZipRecruiter.com, partner sites, and in job alert emails. Your job gets an increased ranking score, which boosts its visibility in search results. Apply a TrafficBoost, and your job is promoted for up to 30 days or until it receives the specified number of views.

TrafficBoost levels

Level	Views	Duration
single	100 views	30 days
double	200 views	30 days
triple	300 views	30 days

Example

Features model example

{
    "features": {
        "trafficboost": "double"
    }
}

Operations

The endpoint https://api.ziprecruiter.com/partner/v0/job/<JOB_ID>/features supports read and write operations.

Parameter	Description
JOB_ID	The ID of the job to which the Features are attached.

Create a Feature

Adds a feature to an existing job. The body must contain a JSON object matching the features model.

warning

Once a TrafficBoost has been applied to a job, it cannot be removed or changed to another level.

POST https://api.ziprecruiter.com/partner/v0/job/<JOB_ID>/features

Example request

curl https://api.ziprecruiter.com/partner/v0/job/emlwcmVjcnVpdGVy-3215/features \
  -H "Authorization: Basic YOUR_API_KEY" \
  -X POST \
  -H "Content-Type: application/json" \
  -d @features.json

Example response

Response

{
    "success": true,
    "features": {
        "trafficboost": "single"
    }
}

note

If the request succeeds but the user lacks a valid payment method or another issue occurs, success will be true but the trafficboost status will remain none.

Get Features

Retrieves the current state of Features associated with a job. Lists all possible features along with their status (none if not set).

GET https://api.ziprecruiter.com/partner/v0/job/<JOB_ID>/features

Example request

curl "https://api.ziprecruiter.com/partner/v0/job/emlwcmVjcnVpdGVy-3215/features" \
  -H "Authorization: Basic YOUR_API_KEY"

Example response

Response

{
    "success": true,
    "features": {
        "trafficboost": "single"
    }
}

Error Responses

Errors from the Features API return HTTP status 400 with a JSON body describing the problem:

Example error response

{
  "error": "Invalid Payload: trafficboost value is not valid.",
  "success": false
}

Error scenarios

Status	Scenario
400	Invalid TrafficBoost level.
400	Missing required features field.
401	Invalid or missing API key.
404	Job not found.
500	Internal Server Error — try again later.