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

Employer access token.

Request​

Path Parameters

    campaignId stringrequired

    Campaign ID of the campaign to update.

Body

required

The request body must be a JSON object that defines campaign updates.

HTTP request headers

Include these HTTP request headers:

  • Content-Type: application/json

  • Accept: application/json

Updates

Fields that are null or omitted keep their current value.

If you change jobsToInclude to ALL, the API clears existing values for jobsQuery, jobsTitle, jobsCompany, jobsLocation, and jobsLocationRadius.

Objectives

You cannot set or change objectives for average daily budget (ADB) campaigns (STANDARD and PREMIUM).

You can add an objective to a campaign that does not have one and update its target, but you cannot remove the objective or change its objectiveType.

    name string

    Possible values: non-empty and <= 250 characters

    Campaign name.

    Use it to identify the campaign later.

    It must be unique within the employer account.

    trackingToken string

    Possible values: <= 255 characters

    Click-tracking token added to the job URL for sponsored clicks.

    Use it to identify clicks from Indeed and the campaign that sponsored them.

    status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Campaign status.

    ACTIVE starts the campaign.

    PAUSED keeps the campaign inactive or temporarily stops sponsorship.

    DELETED stops sponsorship and hides the campaign from the default view in the campaign management portal.

    jobsToInclude string

    Possible values: [ALL, QUERY]

    Required. Use ALL or QUERY.

    ALL sponsors all jobs in the job source.

    ALL ignores and clears jobsQuery, jobsTitle, jobsCompany, jobsLocation, and jobsLocationRadius.

    QUERY sponsors only jobs that match the criteria.

    If you provide multiple criteria, jobs must match all of them.

    If jobsToInclude is QUERY and no criteria are provided, the campaign currently sponsors all jobs in the job source.

    To avoid errors, provide at least one criterion or set jobsToInclude to ALL.

    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 update only jobsQuery and jobsToInclude.

    For average daily budget (ADB) campaigns, update requests fail if they match more than 900 jobs.

    If jobs are resolved dynamically, only 900 jobs are sponsored.

    jobsTitle string

    If set, the campaign sponsors only jobs with this title.

    Applies only when jobsToInclude is QUERY.

    jobsCompany string

    If set, the campaign sponsors only jobs from this hiring company.

    Applies only when jobsToInclude is QUERY.

    jobsLocation string

    If set, the campaign sponsors only jobs at or near this location.

    Applies only when jobsToInclude is QUERY.

    jobsLocationRadius int32

    Default value: 25

    Maximum distance from the job location to jobsLocation in the job query.

    Valid values are 5, 10, 15, 25, 50, and 100.

    Use miles for jobs in the United States and United Kingdom.

    Use kilometers elsewhere.

    UpdateAvgDailyBudgetConfig

    object

    Average daily budget (ADB) details.

    Required to update an ADB campaign budget.

    budgetBoostPercentage integer

    Possible values: <= 1500

    Boost the base average daily budget (ADB) per job by a percentage.

    Use this field only for flexible ADB campaigns. Do not use it for monthly or one-time campaigns.

    Newly added jobs, whether added manually or through query resolution, inherit the same percentage increase over their recommended budgets.

    Valid values: 0 to 1500.

    objective

    object

    Hiring goals for the campaign. Setting this field makes the campaign an objective-based campaign.

    See Setting Up a Sponsored Job Campaign.

    This value is a JSON object with:

    • objectiveType, which specifies the campaign objective
    • target, which specifies the goal metric for some objective types

    For example, to target 10 applications:

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

    You can add an objective to a campaign that does not already have one, and you can change the target value. 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. You cannot update this field for average daily budget (ADB) campaigns (STANDARD and PREMIUM). Available values:

    • BALANCE: Maximize total applications for your budget while balancing spend across jobs.
    • MAXIMUM: Maximize total applications for your budget without balancing clicks across jobs.
    • QUICK: Five-day campaign with a higher budget for faster results. You cannot create or update campaigns with this objective through Sponsored Jobs API. You can still retrieve reports for campaigns with this objective if they were created in Indeed for Employers.
    • TARGET_APPLICATIONS: Aim for the number of applications specified by target. When the target is reached, spend on those jobs is greatly reduced and shifted elsewhere.
    • TARGET_COST_PER_APPLICATION: Aim to keep the cost per application below the value specified by target.
    • SCHEDULED_INTERVIEWS: Send screened candidates directly to interview and aim for the number of interviews specified by target. This objective requires an active Indeed Hiring Platform subscription and should be used only if the customer is ready to create hiring events for the included jobs.

    Campaigns created outside your application might use new objective types that your application does not yet support. Add fallback logic to handle unexpected objectiveType values.

    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?