Addendum to campaign creation

Partners who are approved for access to auto-source claiming can use this guide to create campaigns.

 

legal notice

Unless you have a written agreement with Indeed regarding your use of Indeed's APIs, by using this API or its documentation, you agree to apply the Indeed API Terms and the Additional API Terms and Guidelines to your use of Indeed's APIs.

Document objective

This document supplements the Sponsored Jobs API reference. It is for partners that integrate with the Sponsored Jobs API and have access to auto-source claiming, which is a process that enables advertisers to create campaigns at Indeed, without Indeed claiming and assigning sources to advertisers.

This document is not a comprehensive API doc, but it is an addendum for campaign creation only. In this document, and in the Sponsored Jobs API reference), the terms employer and advertiser are interchangeable and represent the user who sponsors jobs at Indeed.

Send technical questions about this feature to marketplacesupport@indeed.com .

Create campaigns

Use this endpoint to create a campaign:

Create a campaign

Verb	Endpoint	See
POST	/v1/campaigns	Sponsored Jobs API reference

This endpoint returns the ID of the created campaign. Store and use this campaign ID to make changes to or get reports for the campaign.

• When you create a campaign, set the budget and the duration that the employer chooses. The budget must be in the same currency as the employer's default currency.
• For each job, use its unique reference number that is set in the XML job feed format.
• All dates have the YYYY-MM-DD format and in US Central time zone.

Parameters for campaign creation

Parameters for campaign creation

Parameter	Description
jobsToInclude	Set to query.
jobsQuery	To include specific jobs from your XML job feed, use refnum:xxxxx, where the refnum matches the value of the referencenumber node in the XML job feed. To include jobs matching the query, use a generic query.
jobsSourceName	Sponsored Jobs API reference for non-ATS partners do not document this field. It is only available for use by partners approved for auto-source claiming. Pass the value of the sourcename node from the job in the XML job feed in this field.

If the employer chooses a monthly recurring campaign

Monthly recurring campaigns follow the calendar month

Monthly recurring campaigns

Field	Description
budgetMonthlyLimit	The budget amount.
budgetFirstMonthBehavior	Set to startNowProratedAmount

If the employer chooses a fixed duration campaign

Fixed duration campaigns

Field	Description
budgetOnetimeLimit	The budget amount.
startDate	The campaign start date; Defaults to today (current day). In the YYYY-MM-DD format, specified in the US Central time zone.
targetEndDate or fixedEndDate	Set either a targetEndDate or a fixedEndDate for the campaign. In the format YYYY-MM-DD, specified in the US Central time zone. targetEndDate – Indeed efficiently optimizes budget spending by this date. However, if the campaign still has a budget remaining, the campaign continues to spend past this date. fixedEndDate – A hard stop date for the campaign. Indeed efficiently optimizes budget spending by this date and also ensures that the campaign doesn’t spend beyond the specified date.

Access delegation and auto-source claiming

With the OAuth scopes introduced in the Sponsored Jobs API, permissions are tied to the OAuth app registered with Indeed. The requirements for auto-source claiming are based on how you access the Sponsored Jobs API.

Access delegation and auto-source claiming

How you access Sponsored Jobs APIs	What you need to do
You are an agency and you registered the OAuth app using your credentials.	Nothing. No further action is needed.
You are an agency,and you use a programmatic partner to manage your Sponsored Jobs API integration. The programmatic partner has registered the OAuth app using their credentials	Use Authorization code grant type (3-legged OAuth) to delegate access to the programmatic partner.
You are an agency, and you use multiple programmatic partners to manage your Sponsored Jobs API integration. The programmatic partners have registered the OAuth App with their credentials.	For each of your subaccounts, add the programmatic partner managing that subaccount as a secondary user of the account.

 

Was this page helpful?