• iCIMS Corporate Site
  • iCIMS Partners
  • Additional Resources
  • Recent Updates
  • FAQ
  • Login
  • GETTING STARTED
    • Getting Started
    • Integration Approval Process
    • How-To Videos
    • Acceptable Use Policy
    • Terms of Use
    • Release Notes
  • API
    • Licenses
    • Connecting, Authenticating, and Identity
    • Authenticating API Calls with OAuth 2.0
    • HMAC
    • Error Handling
    • Error Reporting Standard for Vendors
    • Field Types
  • Standard Integrations
    • Assessments
    • Candidate Matching
    • Candidate Ranking
    • Document Management
    • Data Analytics and Reporting
    • Human Capital Management
    • I-9 & E-Verify
    • Job Advertising
    • Job Posting
    • Partner Screening
    • Reference Checks
    • Tax Credits
    • Video Interviewing
  • Prime Integrations
    • Prime Assessments
    • Prime Background Screen
      • Implementation
  • Endpoints
    • Binary Collection Fields
    • Binary Files
    • Collection Fields
    • Customers
    • Direct Linking
    • iForms
    • Job Distributor
    • Job Portal API
    • List API
    • Offer API
    • Onboard API
    • Profiles
    • Schema API
    • Search API
    • Workflows
  • Streaming Endpoints
  • Data Models
    • iForms
    • Job
    • Location
    • New Hire Category
    • Onboarding Workflow
    • Person
    • Recruiting Workflow
    • Room
    • Sourcing Workflow
    • Talent Pool
    • Event
    • Validation
  • Integration Events
    • Best Practices
    • Application Complete
    • Job Edit
    • Job Posting
    • Job Unposting
    • Onboard Portal Task
    • Status Flow Update
  • OTHER TECH
    • File-Based Transfers
      • Scheduled Import/Export Licenses
      • Imports
      • Exports
      • File Formatting
      • Import File Examples
    • SAML
    • Standard XML Feed for Job Boards
  • Forum

Search form

Developer Resources
  • Getting Started
  • API
  • Standard Integrations
  • Prime Integrations
  • Endpoints
    • Binary Collection Fields
    • Binary Files
    • Collection Fields
    • Customers
    • Direct Linking
    • iForms
    • Job Distributor
    • Job Portal API
    • List API
    • Offer API
    • Onboard API
    • Profiles
    • Schema API
    • Search API
    • Workflows
    • Standard Apply Framework Questions
  • Streaming Endpoints
  • Data Models
  • Integration Events
  • OTHER TECHNOLOGY
  • FAQ

Job Distributor

The Job Distributor API allows job distributers to communicate the following information with iCIMS:

  • Job boards the job has been posted to
  • Status of the job board posting

Notes:

  • The security for this API is the same as all other iCIMS APIs: all requests must be made over SSL and IP restrictions prevent unwanted traffic.
  • This API supports GET, POST, and PATCH requests.
PATCH Request

When a recruiter posts a job to a job distributor from the iCIMS Platform, the Platform sends a POST request to the Job Distributor API. After retrieving all data required for the Job Posting through GET Requests, the Job Distributor responds back 303 with a redirect URL for its remote site, which the recruiter logs in to to complete the posting, anytime in the future.

If there is any update or change in the status of a job in the Job Distributor's system, the Job Distributor sends a notification to the iCIMS Platform with a PATCH Request, outlined below. The change could be in status, start date, end date, adding a job board, or removing a job board. 

Notes:

  • The following statuses are supported by the iCIMS Platform. (Statuses are case-insensitive. There is a single space between words in a status; more than one space is invalid.)
    • Expired
    • Live
    • Posting in Progress
    • Deletion in Progress
    • Unposted
  • It is required to send the parameters and their value (value, externalid, status, startdate, and enddate) for all job boards, even if only one gets updated/changed.
  • The following date & time format is supported by the iCIMS Platform: YYYY-MM-DDhh:mmAM/PM. (Example: 2014-12-04 11:31 AM )
URL: 

https://api.icims.com/customers/{custId}/jobboardposts/

ExternalId
ExternalId refers to the unique ID of JobBoard in Job Distributor’s system.
Action
Definition
Patch: 

{   

   "jobid":"1234", 

   "jobdistributor":{   

      "id":"D90005" 

   }, 

   "jobboards":[   

      {   

         "jobboard":{   

            "value":"CareerBuilder.com", 

            "externalid":"764" 

         }, 

         "status":"live", 

         "startdate":"2014-08-04 11:31 AM", 

         "enddate":"2014-12-04 11:31 AM" 

      }, 

      {   

         "jobboard":{   

            "value":"Monster.com", 

            "externalid":"763" 

         }, 

         "status":"Posting in Process", 

         "startdate":"2014-08-04 11:31 AM", 

         "enddate":"2014-12-04 11:31 AM" 

      } 

   ] 

} 

Errors: 

HTTP Response: 5xx, 4xx 

Payload: 

{

"message": "",

 "code":  

}

Sample Response: 

 HTTP Response:     204 

Do you have any questions or feedback regarding iCIMS' API documentation? Email the team
See Recent Site Updates

© 2023 iCIMS, Inc. All rights reserved.
Privacy Notice | Terms of Use