Standard Job Fields

The API supports sending any SmashFly Standard job fields.

Some standard fields are required for the Add action and some are required for the Update action. Some of the fields do not specifically need to be included in the API call, as long as they are set by the Intellipost template or Intellipost rules.

Field values that include special characters must be wrapped in beginning and ending CDATA tags.

Fields Required for Add Action

The following fields are required for adding jobs; those with asterisks (*) are typically populated by Intellipost templates or rules and do not need to be specifically passed in the Add action if they are populated by Intellipost:

  • ApplyURL
  • CompanyName*
  • Contact_FirstName*
  • Contact_LastName*
  • ContactEmail*
  • IndustryJobCode*
  • InternalJobID*
  • JobAction
  • JobCountry*
  • JobDescription
  • JobTitle
  • JobType*

Required Fields for Update Action

The following fields are required for updating jobs:

  • ApplyURL
  • CompanyName (if passing this field with the Add action rather than setting through Intellipost)
  • Contact_FirstName (if passing this field with the Add action rather than setting through Intellipost)
  • Contact_LastName (if passing this field with the Add action rather than setting through Intellipost)
  • ContactEmail (if passing this field with the Add action rather than setting through Intellipost)
  • InternalJobID
  • JobAction
  • JobTitle
  • Any other required fields that are not handled in the Intellipost template

Fields Typically Populated by the Intellipost Template or Rules

The following fields are typically configured to be set on jobs by the Intellipost template or Intellipost rules and therefore do not specifically need to be included in an API call unless you want to change the value set by Intellipost:

  • CompanyName
  • Contact_FirstName
  • Contact_LastName
  • ContactEmail
  • IndustryJobCode
  • InternalJobID
  • JobCountry
  • JobType

The SmashFly customer Administrator user can view the Intellipost template and rules in the Configuration module by selecting Intellipost Configuration.

Standard Fields

This table includes all available standard job fields that can be passed through the API, with the exception of fields that are typically used only by resellers for billing purposes.

For fields with a type of lookup, click the link on the field parameter name to view valid values for that field.

Field Parameter Name

 Field Display Name

Description

Recommended for Common Scope

Field Type

ApplyURL

 Job Apply URL

URL to which the SmashFly Job Ads will redirect for an applicant to apply for the job. Typically, this is the ATS Job Description or the Job Application Login URL.

Yes

String

Bonus

 Bonus

Bonus Compensation for the job. This field is not typically distributed to job boards.

No

Numeric

Commission

 Commission

Commission Compensation for the job. This field is not typically distributed to job boards. (This field has been retired.)

No

Numeric

CompanyName

 Company Name

Name of the organization; the field is typically specified on the Intellipost template, but it should be passed in the API for multi-company customers.

No

String

ContactEmail

 Contact Email Address

Email address for person to contact about the job. This field is typically specified on the Intellipost template as a dummy or central email address.

No

String

ContactFax

 Contact Fax

Fax number for the person to contact for the job. This field is typically not specified.

No

String

Contact_FirstName

 Contact First Name

First name and last name, respectively of the person to contact about job. This field is typically specified on the Intellipost template as “Recruiting Team” to depersonalize requisitions. This field may be passed to job boards

No

String

Contact_LastName

 Contact Last Name

No

String

ContactPhone

 Contact Phone

Phone number for the person to contact for the job. This field is typically not specified.

No

String

Currency

Currency

Currency in which remuneration is expected to be paid for the job. This field is not typically distributed to job boards.

No

Lookup

Education

Education

Minimum education required for the job. This field is not typically distributed to job boards.

No

Lookup

IndustryJobCode

Job Category

Job Category/Code/Function of the job.

This field is required to create a job in the SmashFly system, but it can be specified in Intellipost settings if the source system cannot send SmashFly lookup values.

No

Lookup

InternalJobID

 Job ID

ATS Job ID and primary key for the job. This field is required for all job API acions (Add, Update, and Delete). If a job is not found by Job ID, we consider the call to be an ADD action; otherwise, it is either an UPDATE or DELETE, based on what is specified in the JobAction node.

Yes

String

Job Action

 *Used for API only

Action to take for the job. Possible values are as follows:

  • Add
  • Update
  • Delete

This field is required for all Job API actions. The Job Action is listed for each job submitted in the call.

Yes

Lookup

Job City

 City

City for the primary location for the job.

Yes

String

Job Country

 Country

Country for the primary location for the job. Where possible, use the ISO Country Code (such as US for United States, CA for Canada, and so on).

Yes

Lookup

JobDescription

 Description

The full HTML job description for the job. Note that while some ATSs have more than one field for Job Description (for example, Description and Qualifications/Requirements), those different fields should be concatenated and sent in a single JobDescription node to SmashFly. Full HTML is accepted, and the CDATA tag is required.

Yes

HTML String

JobExperience

Experience

The level of experience expected for the job. This field is required on some job boards, but it is not required to create a job in SmashFly.

No

Lookup

JobState

 State/Prov.

The State, Province, or Region of the primary location for the job. Provide the SmashFly code for the state, province, or region (using the lookup tables for North America or outside of North America. If no code is specified in the lookup table, any string up to 50 characters can be passed.

Yes

String
JobTeam Team Members SmashFly team, contact name, or email address of the individual to associate with the job as the job team for this role. This field can include multiple values. No String

JobTitle

 Job Title

The External Job Title from the ATS.

Yes

String

JobType

Job Type

Type of Job; possible values are as follows:

  • Full Time
  • Part Time
  • Contract
  • Temporary

This field is required to create a job in the SmashFly system, but it can be specified in Intellipost settings if the source system cannot send SmashFly lookup values.

No

Lookup

JobZipCode

 ZIP/Postal

The ZIP (postal) code for the primary location the job. This field is highly recommended for accurate searches on job boards. If it is not provided, SmashFly will perform a lookup to set the ZIP code based on the city/state combination. If no ZIP code exists for the provided location, ZIP Code will be blank, which may cause failure to post to some boards.

Yes

String
Manager Manager SmashFly contact name or email address of individual to associate with the job as the manager for this role. Yes String

MaximumSalary

 Maximum Salary

Maximum value in the salary range for the job. This field is not typically distributed to job boards.

No

Numeric

MinimumSalary

 Minimum Salary

Minimum value in the salary range for the job. This field is not typically distributed to job boards.

No

Numeric

PayPeriod

Pay Period

Frequency at which pay is received for the job. This field is not typically distributed to job boards.

No

Lookup
Recruiter Recruiter SmashFly contact name or email address of individual to associate with the job as the recruiter for this role. Yes String

Shift

Shift

Shift for the job. This field is not typically distributed to job boards.

No

Lookup

Travel

Travel

Frequency at which travel is required or expected for the job, stated as a percentage of working time. This field is not typically distributed to job boards.

No

Lookup

WillingToRelocate

Willing to Relocate

If relocation is required or if a job seeker must be willing to relocate for the job, this value can be set to “Yes." This field is not typically distributed to job boards.

No

Lookup

 

Recommended Fields for Job API Scope

The following fields are recommended for Job API Scope, even though many of them are not required:

  • ApplyURL
  • InternalJobID
  • JobAction
  • JobCity
  • JobCountry
  • JobDescription
  • JobState
  • JobTitle
  • JobZipCode
  • Manager
  • Recruiter
  • Any custom fields for Job Category, Designation, or Type (Full or Part Time)

Fields Typically Used by Resellers Only

The following fields are relevant specifically for resellers for billing purposes and are typically not used by customers:

  • BillingCountry
  • BillingState
  • Country
  • CreditCardType
  • Currency
  • ExpirationMonth
  • ExpirationYear