Update campaign budget and duration

PATCH /v1/campaigns/:campaignId/budget

Updates campaign budget, duration, or both. Null or absent properties keep current values. Not available for bonus credit campaigns.

OAuth scope	Access token type
`employer.advertising.campaign`	Access token that represents an employer. See Get access token that represents employer.

Request

Path Parameters

campaignId stringrequired

Campaign ID.

application/json

Body

required

'Be sure to include the Content-Type: application/json header in the request.'

budgetOnetimeLimit number

If set, the campaign has a single budget for the whole duration of the campaign. You must always specify either budgetOnetimeLimit or budgetMonthlyLimit, but not both.

The budget appears in the employer account's currency. Sponsored Jobs API parses, stores, and returns the value as an exact decimal fraction, not as a floating point number.

budgetMonthlyLimit number

Monthly recurring budget for the campaign. The end date is optional for campaigns with a monthly recurring budget. You must always specify exactly one budgetOnetimeLimit or budgetMonthlyLimit.

The budget appears in the employer account's currency. Sponsored Jobs API parses, stores, and returns the value as an exact decimal fraction, not as a floating point number.

budgetFirstMonthBehavior string

Possible values: [startNowProratedAmount, startNowFullAmount, startNextMonthFullAmount]

If a campaign has a monthly recurring budget (budgetMonthlyLimit is specified) and the start date of the campaign is not the first day of the month, this specifies how the budget for the first month is calculated.

Value	Meaning	Example: Applied budget when the monthly budget is 900 USD and the start date is June 11
Value	Meaning	June 11-30	July 1-31
`startNowFullAmount`	The budget for the first month is the full monthly amount.	900 USD	900 USD
`startNowProratedAmount`	The budget for the first month is proportional to the number of days remaining in the month after the start date.	600 USD	900 USD
`startNextMonthFullAmount`	The campaign won't have any budget and won't sponsor any jobs in the first month.	0 USD	900 USD

startDate date

Date when the campaign starts sponsoring jobs, in ISO 8601 YYYY-MM-DD format. Default is current date.

The campaign starts sponsoring jobs at the start of the specified day in US Central Time (CT, US/Central). The start date must be on or after the current date in CT. For example, if the startDate is 2021-01-15, the campaign starts sponsoring on January 15, 2021 at 0:00 AM CT. If the start date is not provided or is the current date, the campaign starts sponsoring immediately.

Once the campaign is active and spending, you cannot update its startDate. If you wish to temporarily pause a campaign, set its status to PAUSED.

fixedEndDate date

Date before when the campaign must stop sponsoring jobs, even if it has remaining unspent budget. Follows the ISO 8601 YYYY-MM-DD format.

A campaign with a one-time budget (budgetOnetimeLimit) must always have either a fixedEndDate or a targetEndDate, but not both.

A campaign with a monthly recurring budget (budgetMonthlyLimit) may optionally have a fixedEndDate. Monthly recurring campaigns default to sponsoring jobs until you manually pause or delete the campaign. These are called "evergreen" campaigns. To stop the campaign at the start of a specified day, specify fixedEndDate.

The campaign stops sponsoring jobs at the start of the specified day in US Central Time (CT, US/Central). The fixedEndDate must be at least one day after the current date in CT, or the startDate of the campaign, if the campaign has one. For example, if the fixed end date is 2021-06-20, the campaign stops on June 20, 2021 at 0:00 AM CT.

targetEndDate date

Date before when the campaign should stop sponsoring jobs, though it can continue sponsoring past the specified date if it has not spent its budget yet. Follows the ISO 8601 YYYY-MM-DD format.

A campaign with a one-time budget (budgetOnetimeLimit) must always have either a fixedEndDate or a targetEndDate, but not both. A campaign with a monthly recurring budget (budgetMonthlyLimit) cannot have a targetEndDate, only a fixedEndDate or no end date.

The campaign targets the start of the specified day in US Central Time (CT, US/Central). The target end date must be at least one day after the current date in CT, or the startDate of the campaign, if the campaign has one. For example, if the target end date is 2021-06-20, the campaign targets June 20, 2021 at 0:00 AM CT.

Responses

Success

application/json

Schema
Example (from schema)
Example

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

Campaign ID of the updated campaign.

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": {
    "campaignId": "cda7fa7645b613d5"
  }
}

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      },
      {
        "rel": "Campaign Info",
        "href": "/v1/campaigns/bceed88523d89731"
      },
      {
        "rel": "Traffic Statistics",
        "href": "/v1/campaigns/bceed88523d89731/stats"
      }
    ]
  },
  "data": {
    "campaignId": "bceed88523d89731"
  }
}

A request parameter is not valid. The description field usually contains the name of the problematic parameter and a more detailed error message. Unlike other error types, the meta.errors array may contain multiple INVALID_REQUEST errors, one for each request parameter with a problem.

application/json

Schema
Example (from schema)
Updating start date after campaign is active
Multiple types of end date

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

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

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "startDate: Cannot update the start date for this campaign."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "targetEndDate: You can only have one end date type, either fixed or target."
      },
      {
        "type": "INVALID_REQUEST",
        "description": "fixedEndDate: You can only have one end date type, either fixed or target."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      }
    ]
  },
  "data": null
}

Request did not include a valid access token:

The Authorization header is missing or malformed. Include the access token using the Bearer scheme — for example, Authorization: Bearer XYZ.
The access token is malformed. When building requests manually, check that you copied the token without missing or extra characters at the start or end.
The access token has expired. Tokens expire after one hour (3,600 seconds). Get a new token using your client credentials (2-legged OAuth) or a refresh token (3-legged OAuth).

application/json

Schema
Example (from schema)
Example

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

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

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 401,
    "errors": [
      {
        "type": "INVALID_TOKEN",
        "description": "Invalid OAuth access token."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Valid access token that cannot be used with this API. Inspect the error returned in the meta.errors for details.

Error type	Meaning and common causes
`INSUFFICIENT_SCOPE`	The access token does not have the OAuth v2 token scope required for this API endpoint. For common causes, see FAQ and troubleshooting.
`NOT_EMPLOYER_ACCESS_TOKEN`	This endpoint requires an access token that represents an employer. See Get access token that represents employer. That is, you must specify the `employer` parameter when requesting the access token. You need to do this for the majority of the Sponsored Jobs API endpoints.
`LEGACY_ACCESS_TOKEN_NOT_ALLOWED`	Sponsored Jobs API no longer supports access tokens that you get through legacy OAuth endpoints. For updated endpoints, see Integrate with Indeed and call APIs

application/json

Schema
Example (from schema)
Example

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

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

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 403,
    "errors": [
      {
        "type": "INSUFFICIENT_SCOPE",
        "description": "Access token does not have permission to access this API."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Requested campaign either does not exist or belongs to another employer. Be sure to use an access token that represents the employer that owns the requested campaign. See Get access token that represents employer.

application/json

Schema
Example (from schema)
Example

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

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

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 404,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": {
      "rel": "up",
      "href": "/v1/campaigns"
    }
  },
  "data": null
}

Unexpected error occurred. The problem is sometimes temporary and the exact same request may succeed after retrying.

If retrying the request does not help, a problem with parsing the request might have occurred. Make sure that all the required parameters are present and that all parameters are correctly formatted.

If you use an access token obtained with client credentials grant type (2-legged OAuth) with the legacy Sponsored Jobs API endpoint, the INTERNAL_SERVER_ERROR error occurs. Be sure to use the latest base URL (https://apis.indeed.com/ads).

application/json

Schema
Example (from schema)
Example

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

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

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 500,
    "errors": [
      {
        "type": "INTERNAL_SERVER_ERROR",
        "description": "Failed to process the request."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Update campaign budget and duration

Request​

Path Parameters

Body

Responses​

Schema

Schema

Schema

Schema

Schema

Schema

Was this page helpful?

Request

Responses