Skip to main content

Update general campaign information

PATCH 
/v1/campaigns/:campaignId

Updates the basic properties of a sponsored jobs campaign.

OAuth scopeAccess token type
employer.advertising.campaign

Access token that represents an employer.

Request​

Path Parameters

    campaignId stringrequired

    Campaign ID of the campaign to update.

Body

required

Request body must be a JSON object that describes the changes to make to the campaign. Be sure to include the Content-Type: application/json header in the request.

Any fields that are null or absent from the request keep their current value. However, if you change jobsToInclude to ALL, any existing values of jobsQuery, jobsTitle, jobsCompany, jobsLocation and jobsLocationRadius are cleared.

You can add an objective to a campaign that doesn't have one, and change the target value of an objective. However, you cannot remove an objective or change its objectiveType.

    name string

    Possible values: non-empty and <= 250 characters

    Campaign name. Use to identify the campaign later. The name must be unique within your employer account.

    trackingToken string

    Possible values: <= 255 characters

    Click-tracking token appended to the job URL on sponsored clicks. Allows you to identify that the click is from Indeed, and identify the campaign that sponsored the click.

    status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Campaign status. Set to PAUSED or DELETED to stop the campaign from sponsoring jobs. If DELETED, the campaign is additionally hidden from the default view in the campaign management portal.

    jobsToInclude string

    Possible values: [ALL, QUERY]

    • ALL - Campaign sponsors all the jobs in the job source. The jobsQuery, jobsTitle, jobsCompany, jobsLocation, and jobsLocationRadius fields' values are ignored, and any existing values are cleared.
    • QUERY - Campaign sponsors a subset of jobs that match the criteria defined by jobsQuery, jobsTitle, jobsCompany, jobsLocation, and jobsLocationRadius fields. If more than one field is specified, only jobs that match all the criteria are sponsored.

    Note: If jobsToInclude is QUERY with no criteria, all jobs are sponsored. This will error in future versions. Specify at least one criterion, or set jobsToInclude to ALL. For bonus credit campaigns, employers can only update jobsQuery and jobsToInclude.

    jobsQuery string

    Sponsors only jobs that match these search terms. Supports boolean expressions. See Indexed jobs query format. Applies only when jobsToInclude is QUERY. For Bonus Credit campaigns, employers can only update jobsQuery and jobsToInclude.

    jobsTitle string

    If specified, the campaign sponsors only jobs with this job title. Applies only if jobsToInclude is QUERY.

    jobsCompany string

    If specified, the campaign sponsors only jobs with this hiring company. Applies only if jobsToInclude is QUERY.

    jobsLocation string

    If specified, the campaign sponsors only jobs at or near this location. Applies only if jobsToInclude is QUERY.

    jobsLocationRadius int32

    Default value: 25

    Maximum distance between the job location and the location specified by jobsLocation. Valid value is 5, 10, 15, 25, 50, and 100. If the job is located in the United States or the United Kingdom, the unit is miles. Otherwise, the unit is kilometers.

    objective

    object

    Specifies the hiring goals that the campaign is intended to achieve, and makes the campaign into an objective-based campaign. The value is a JSON object with an objectiveType field specifying the campaign objective, and for some objective types, a target field identifying the specific goal metric.

    For example, if the goal of the campaign is to supply 10 apps, set the objective to:

    {
      "objectiveType": "TARGET_APPLICATIONS",
      "target": 10
    }

    You can add an objective to a campaign that doesn't have one, and change the target value of an objective. However, you cannot remove an objective or change its objectiveType.

    objectiveType

    string

    Possible values: [BALANCE, MAXIMUM, QUICK, TARGET_APPLICATIONS, TARGET_COST_PER_APPLICATION, SCHEDULED_INTERVIEWS]

    The campaign objective. The available values are:

    • BALANCE: Get the most total applications for your budget, while balancing across jobs.
    • MAXIMUM: Get the most total applications for your budget, without balancing clicks across.
    • QUICK: Five day campaign with higher budget for faster results. Sponsored Jobs API does not currently support creating or modifying campaigns with this objective. However, the Sponsored Jobs API does allow for retrieving campaign reports for campaigns with this objective type (these campaigns would have been created using Indeed for Employers).
    • TARGET_APPLICATIONS: Aim to reach the number of applications specified by target. When the target number of applications is hit, spend on these jobs is significantly reduced and allocated elsewhere.
    • TARGET_COST_PER_APPLICATION: Aim to keep the cost per application below the number specified by target.
    • SCHEDULED_INTERVIEWS: Send screened candidates straight to interview. Aim to reach the number of interviews specified by target. This objective requires an active Indeed Hiring Platform subscription, and should only be used when the customer is prepared to create hiring events for the included jobs.

    Campaigns created outside your app can use latest objective types. See Ensure compatibility with API changes that your app does not support yet. To handle unexpected objectiveType values, ensure your app has fallback logic.

    any

Responses​

Returns HTTP 200 status code on success.

Schema

    meta

    object

    Response-related metadata.

    status int32

    HTTP status code of the response.

    errors

    object[]

    Any errors that prevented successful processing of the request. If there were no errors, the value is null.

  • Array [

    • type string

    Name of the error.

    description string

    Human-readable description of the problem.

  • ]

    • rootLocation string

    Base URL of the Sponsored Jobs API.

    perPage int32

    For endpoints that return paginated results, the effective maximum number of entries returned on one page. The value may be smaller than the maximum you requested with the perPage parameter. If the endpoint returns a single result or doesn't paginate, the value is null.

    links

    object[]

    Resources related to the requested resource.

  • Array [

    • rel string

    The relationship between the requested resource and the related resource. These values are commonly used:

    • up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.
    • next: The next page of entries in a paginated result.
    • prev: The previous page of entries in a paginated result.

    However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

    href string

    Endpoint URL of the related resource. Can contain query string parameters. To get the complete URL, append the href to rootLocation.

  • ]

    • data

    object

    campaignId string

    The campaignId value in the request.

Loading...

Was this page helpful?