Careers

Career Center (v1-2025-04-18)

Service providing access to Career Center resources and features

Download OpenAPI description

careers-v1.json

careers-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/

https://careers.api.rhythmsoftware.com/

Employer Profiles

Operations

Job Boards

Operations

Job Posting Applications

Operations

Job Posting Processes

Operations

Gets all of the job posting processes in the system.

Request

This method will scan all job posting processes and and return them to the caller.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/jobPostingProcesses/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The job posting processeswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

confirmation_emailobject(Confirmation Email)required

Email to send once the job posting is submitted

confirmation_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

confirmation_email.bodystring(Body)required

The email body

confirmation_email.ccstring(Cc)

Anyone that should be cc'ed on the email

confirmation_email.fromstring(From)

From email address

confirmation_email.from_namestring(From Name)

From name

confirmation_email.reply_tostring(Reply To)

The reply to

confirmation_email.subjectstring(Subject)required

The email subject

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

The description of the process

display_in_portalboolean(Display In Portal)

Whether this process is available in the portal

display_in_portal_asstring(Display In Portal As)required

How to display in portal

display_ordernumber(float)(Display Order)

The order to display

enable_confirmation_emailboolean(Enable Confirmation Email)

Whether or not to send an email when the job posting is processed

enable_expiration_notification_emailboolean(Enable Expiration Notification Email)

Whether or not to send an email when the job posting has expired

enable_job_editingboolean(Enable Job Editing)

If true, job posters can edit jobs in the portal

expiration_notification_emailobject(Expiration Notification Email)required

Email to send once the job posting has expired and has been taken down

expiration_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

expiration_notification_email.bodystring(Body)required

The email body

expiration_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

expiration_notification_email.fromstring(From)

From email address

expiration_notification_email.from_namestring(From Name)

From name

expiration_notification_email.reply_tostring(Reply To)

The reply to

expiration_notification_email.subjectstring(Subject)required

The email subject

form_idstring(Form)careers-job-postings__.*required

The job posting form

idstring(ID)^[\w|-]+$required

The unique, string identifier of this job posting process

is_activeboolean(Is Active)

Whether or not this job posting process is active

job_editing_form_idstring(Job Editing Form)careers-job-postings__.*required

The job posting form

jobs_require_approvalboolean(Jobs Require Approval)

If set, jobs posted using this process require approval

namestring(Name)required

The name of the job posting process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

posting_expirationnumber(float)(Posting Expiration)required

The default expiration of job postings posted during this process in days

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

]

Response

application/json

[
  {
    "confirmation_email": { … },
    "contact_form_options": { … },
    "custom_field_values": [ … ],
    "description": "string",
    "display_in_portal": true,
    "display_in_portal_as": "string",
    "display_order": 0.1,
    "enable_confirmation_email": true,
    "enable_expiration_notification_email": true,
    "enable_job_editing": true,
    "expiration_notification_email": { … },
    "form_id": "string",
    "id": "string",
    "is_active": true,
    "job_editing_form_id": "string",
    "jobs_require_approval": true,
    "name": "string",
    "organization_form_options": { … },
    "posting_expiration": 0.1,
    "show_contact_form": true,
    "show_organization_form": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }
]

Creates a new job posting process record that does not already exist.

Request

This method will auto-generate an ID and create a new job posting process. If an ID is specified for the job posting process, an error will be thrown.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The job posting process that you would like to be saved.

confirmation_emailobject(Confirmation Email)required

Email to send once the job posting is submitted

confirmation_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

confirmation_email.bodystring(Body)required

The email body

confirmation_email.ccstring(Cc)

Anyone that should be cc'ed on the email

confirmation_email.fromstring(From)

From email address

confirmation_email.from_namestring(From Name)

From name

confirmation_email.reply_tostring(Reply To)

The reply to

confirmation_email.subjectstring(Subject)required

The email subject

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

The description of the process

display_in_portalboolean(Display In Portal)

Whether this process is available in the portal

display_in_portal_asstring(Display In Portal As)required

How to display in portal

display_ordernumber(float)(Display Order)

The order to display

enable_confirmation_emailboolean(Enable Confirmation Email)

Whether or not to send an email when the job posting is processed

enable_expiration_notification_emailboolean(Enable Expiration Notification Email)

Whether or not to send an email when the job posting has expired

enable_job_editingboolean(Enable Job Editing)

If true, job posters can edit jobs in the portal

expiration_notification_emailobject(Expiration Notification Email)required

Email to send once the job posting has expired and has been taken down

expiration_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

expiration_notification_email.bodystring(Body)required

The email body

expiration_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

expiration_notification_email.fromstring(From)

From email address

expiration_notification_email.from_namestring(From Name)

From name

expiration_notification_email.reply_tostring(Reply To)

The reply to

expiration_notification_email.subjectstring(Subject)required

The email subject

form_idstring(Form)careers-job-postings__.*required

The job posting form

idstring(ID)^[\w|-]+$required

The unique, string identifier of this job posting process

is_activeboolean(Is Active)

Whether or not this job posting process is active

job_editing_form_idstring(Job Editing Form)careers-job-postings__.*required

The job posting form

jobs_require_approvalboolean(Jobs Require Approval)

If set, jobs posted using this process require approval

namestring(Name)required

The name of the job posting process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

posting_expirationnumber(float)(Posting Expiration)required

The default expiration of job postings posted during this process in days

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/jobPostingProcesses/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "contact_form_options": {
      "contact_form_id": "string",
      "html": "string"
    },
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "display_in_portal": true,
    "display_in_portal_as": "string",
    "display_order": 0.1,
    "enable_confirmation_email": true,
    "enable_expiration_notification_email": true,
    "enable_job_editing": true,
    "expiration_notification_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "form_id": "string",
    "id": "string",
    "is_active": true,
    "job_editing_form_id": "string",
    "jobs_require_approval": true,
    "name": "string",
    "organization_form_options": {
      "html": "string",
      "organization_form_id": "string"
    },
    "posting_expiration": 0.1,
    "show_contact_form": true,
    "show_organization_form": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The job posting process was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

confirmation_emailobject(Confirmation Email)required

Email to send once the job posting is submitted

confirmation_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

confirmation_email.bodystring(Body)required

The email body

confirmation_email.ccstring(Cc)

Anyone that should be cc'ed on the email

confirmation_email.fromstring(From)

From email address

confirmation_email.from_namestring(From Name)

From name

confirmation_email.reply_tostring(Reply To)

The reply to

confirmation_email.subjectstring(Subject)required

The email subject

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

The description of the process

display_in_portalboolean(Display In Portal)

Whether this process is available in the portal

display_in_portal_asstring(Display In Portal As)required

How to display in portal

display_ordernumber(float)(Display Order)

The order to display

enable_confirmation_emailboolean(Enable Confirmation Email)

Whether or not to send an email when the job posting is processed

enable_expiration_notification_emailboolean(Enable Expiration Notification Email)

Whether or not to send an email when the job posting has expired

enable_job_editingboolean(Enable Job Editing)

If true, job posters can edit jobs in the portal

expiration_notification_emailobject(Expiration Notification Email)required

Email to send once the job posting has expired and has been taken down

expiration_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

expiration_notification_email.bodystring(Body)required

The email body

expiration_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

expiration_notification_email.fromstring(From)

From email address

expiration_notification_email.from_namestring(From Name)

From name

expiration_notification_email.reply_tostring(Reply To)

The reply to

expiration_notification_email.subjectstring(Subject)required

The email subject

form_idstring(Form)careers-job-postings__.*required

The job posting form

idstring(ID)^[\w|-]+$required

The unique, string identifier of this job posting process

is_activeboolean(Is Active)

Whether or not this job posting process is active

job_editing_form_idstring(Job Editing Form)careers-job-postings__.*required

The job posting form

jobs_require_approvalboolean(Jobs Require Approval)

If set, jobs posted using this process require approval

namestring(Name)required

The name of the job posting process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

posting_expirationnumber(float)(Posting Expiration)required

The default expiration of job postings posted during this process in days

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "confirmation_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "contact_form_options": {
    "contact_form_id": "string",
    "html": "string"
  },
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "display_in_portal": true,
  "display_in_portal_as": "string",
  "display_order": 0.1,
  "enable_confirmation_email": true,
  "enable_expiration_notification_email": true,
  "enable_job_editing": true,
  "expiration_notification_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "form_id": "string",
  "id": "string",
  "is_active": true,
  "job_editing_form_id": "string",
  "jobs_require_approval": true,
  "name": "string",
  "organization_form_options": {
    "html": "string",
    "organization_form_id": "string"
  },
  "posting_expiration": 0.1,
  "show_contact_form": true,
  "show_organization_form": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/jobPostingProcesses/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a job posting process from the system by its ID.

Request

This method will delete a job posting process with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the job posting process to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/jobPostingProcesses/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The job posting process was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a job posting process from the system by its ID.

Request

This method will look up a job posting process by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the job posting process to return.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/jobPostingProcesses/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The job posting process was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

confirmation_emailobject(Confirmation Email)required

Email to send once the job posting is submitted

confirmation_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

confirmation_email.bodystring(Body)required

The email body

confirmation_email.ccstring(Cc)

Anyone that should be cc'ed on the email

confirmation_email.fromstring(From)

From email address

confirmation_email.from_namestring(From Name)

From name

confirmation_email.reply_tostring(Reply To)

The reply to

confirmation_email.subjectstring(Subject)required

The email subject

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

The description of the process

display_in_portalboolean(Display In Portal)

Whether this process is available in the portal

display_in_portal_asstring(Display In Portal As)required

How to display in portal

display_ordernumber(float)(Display Order)

The order to display

enable_confirmation_emailboolean(Enable Confirmation Email)

Whether or not to send an email when the job posting is processed

enable_expiration_notification_emailboolean(Enable Expiration Notification Email)

Whether or not to send an email when the job posting has expired

enable_job_editingboolean(Enable Job Editing)

If true, job posters can edit jobs in the portal

expiration_notification_emailobject(Expiration Notification Email)required

Email to send once the job posting has expired and has been taken down

expiration_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

expiration_notification_email.bodystring(Body)required

The email body

expiration_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

expiration_notification_email.fromstring(From)

From email address

expiration_notification_email.from_namestring(From Name)

From name

expiration_notification_email.reply_tostring(Reply To)

The reply to

expiration_notification_email.subjectstring(Subject)required

The email subject

form_idstring(Form)careers-job-postings__.*required

The job posting form

idstring(ID)^[\w|-]+$required

The unique, string identifier of this job posting process

is_activeboolean(Is Active)

Whether or not this job posting process is active

job_editing_form_idstring(Job Editing Form)careers-job-postings__.*required

The job posting form

jobs_require_approvalboolean(Jobs Require Approval)

If set, jobs posted using this process require approval

namestring(Name)required

The name of the job posting process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

posting_expirationnumber(float)(Posting Expiration)required

The default expiration of job postings posted during this process in days

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "confirmation_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "contact_form_options": {
    "contact_form_id": "string",
    "html": "string"
  },
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "display_in_portal": true,
  "display_in_portal_as": "string",
  "display_order": 0.1,
  "enable_confirmation_email": true,
  "enable_expiration_notification_email": true,
  "enable_job_editing": true,
  "expiration_notification_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "form_id": "string",
  "id": "string",
  "is_active": true,
  "job_editing_form_id": "string",
  "jobs_require_approval": true,
  "name": "string",
  "organization_form_options": {
    "html": "string",
    "organization_form_id": "string"
  },
  "posting_expiration": 0.1,
  "show_contact_form": true,
  "show_organization_form": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Partially updates a job posting process with the specified ID.

Request

This method will patch an existing job posting process with the specified ID, using the HTTP PATCH specification.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the job posting process to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/jobPostingProcesses/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The job posting process was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

confirmation_emailobject(Confirmation Email)required

Email to send once the job posting is submitted

confirmation_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

confirmation_email.bodystring(Body)required

The email body

confirmation_email.ccstring(Cc)

Anyone that should be cc'ed on the email

confirmation_email.fromstring(From)

From email address

confirmation_email.from_namestring(From Name)

From name

confirmation_email.reply_tostring(Reply To)

The reply to

confirmation_email.subjectstring(Subject)required

The email subject

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

The description of the process

display_in_portalboolean(Display In Portal)

Whether this process is available in the portal

display_in_portal_asstring(Display In Portal As)required

How to display in portal

display_ordernumber(float)(Display Order)

The order to display

enable_confirmation_emailboolean(Enable Confirmation Email)

Whether or not to send an email when the job posting is processed

enable_expiration_notification_emailboolean(Enable Expiration Notification Email)

Whether or not to send an email when the job posting has expired

enable_job_editingboolean(Enable Job Editing)

If true, job posters can edit jobs in the portal

expiration_notification_emailobject(Expiration Notification Email)required

Email to send once the job posting has expired and has been taken down

expiration_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

expiration_notification_email.bodystring(Body)required

The email body

expiration_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

expiration_notification_email.fromstring(From)

From email address

expiration_notification_email.from_namestring(From Name)

From name

expiration_notification_email.reply_tostring(Reply To)

The reply to

expiration_notification_email.subjectstring(Subject)required

The email subject

form_idstring(Form)careers-job-postings__.*required

The job posting form

idstring(ID)^[\w|-]+$required

The unique, string identifier of this job posting process

is_activeboolean(Is Active)

Whether or not this job posting process is active

job_editing_form_idstring(Job Editing Form)careers-job-postings__.*required

The job posting form

jobs_require_approvalboolean(Jobs Require Approval)

If set, jobs posted using this process require approval

namestring(Name)required

The name of the job posting process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

posting_expirationnumber(float)(Posting Expiration)required

The default expiration of job postings posted during this process in days

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "confirmation_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "contact_form_options": {
    "contact_form_id": "string",
    "html": "string"
  },
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "display_in_portal": true,
  "display_in_portal_as": "string",
  "display_order": 0.1,
  "enable_confirmation_email": true,
  "enable_expiration_notification_email": true,
  "enable_job_editing": true,
  "expiration_notification_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "form_id": "string",
  "id": "string",
  "is_active": true,
  "job_editing_form_id": "string",
  "jobs_require_approval": true,
  "name": "string",
  "organization_form_options": {
    "html": "string",
    "organization_form_id": "string"
  },
  "posting_expiration": 0.1,
  "show_contact_form": true,
  "show_organization_form": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Updates a job posting process with the specified ID.

Request

This method will update an existing job posting process with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the job posting process to update.

Bodyapplication/jsonrequired

The updated job posting process that will be saved.

confirmation_emailobject(Confirmation Email)required

Email to send once the job posting is submitted

confirmation_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

confirmation_email.bodystring(Body)required

The email body

confirmation_email.ccstring(Cc)

Anyone that should be cc'ed on the email

confirmation_email.fromstring(From)

From email address

confirmation_email.from_namestring(From Name)

From name

confirmation_email.reply_tostring(Reply To)

The reply to

confirmation_email.subjectstring(Subject)required

The email subject

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

The description of the process

display_in_portalboolean(Display In Portal)

Whether this process is available in the portal

display_in_portal_asstring(Display In Portal As)required

How to display in portal

display_ordernumber(float)(Display Order)

The order to display

enable_confirmation_emailboolean(Enable Confirmation Email)

Whether or not to send an email when the job posting is processed

enable_expiration_notification_emailboolean(Enable Expiration Notification Email)

Whether or not to send an email when the job posting has expired

enable_job_editingboolean(Enable Job Editing)

If true, job posters can edit jobs in the portal

expiration_notification_emailobject(Expiration Notification Email)required

Email to send once the job posting has expired and has been taken down

expiration_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

expiration_notification_email.bodystring(Body)required

The email body

expiration_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

expiration_notification_email.fromstring(From)

From email address

expiration_notification_email.from_namestring(From Name)

From name

expiration_notification_email.reply_tostring(Reply To)

The reply to

expiration_notification_email.subjectstring(Subject)required

The email subject

form_idstring(Form)careers-job-postings__.*required

The job posting form

idstring(ID)^[\w|-]+$required

The unique, string identifier of this job posting process

is_activeboolean(Is Active)

Whether or not this job posting process is active

job_editing_form_idstring(Job Editing Form)careers-job-postings__.*required

The job posting form

jobs_require_approvalboolean(Jobs Require Approval)

If set, jobs posted using this process require approval

namestring(Name)required

The name of the job posting process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

posting_expirationnumber(float)(Posting Expiration)required

The default expiration of job postings posted during this process in days

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/jobPostingProcesses/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "contact_form_options": {
      "contact_form_id": "string",
      "html": "string"
    },
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "description": "string",
    "display_in_portal": true,
    "display_in_portal_as": "string",
    "display_order": 0.1,
    "enable_confirmation_email": true,
    "enable_expiration_notification_email": true,
    "enable_job_editing": true,
    "expiration_notification_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "form_id": "string",
    "id": "string",
    "is_active": true,
    "job_editing_form_id": "string",
    "jobs_require_approval": true,
    "name": "string",
    "organization_form_options": {
      "html": "string",
      "organization_form_id": "string"
    },
    "posting_expiration": 0.1,
    "show_contact_form": true,
    "show_organization_form": true,
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The job posting process was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

confirmation_emailobject(Confirmation Email)required

Email to send once the job posting is submitted

confirmation_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

confirmation_email.bodystring(Body)required

The email body

confirmation_email.ccstring(Cc)

Anyone that should be cc'ed on the email

confirmation_email.fromstring(From)

From email address

confirmation_email.from_namestring(From Name)

From name

confirmation_email.reply_tostring(Reply To)

The reply to

confirmation_email.subjectstring(Subject)required

The email subject

contact_form_optionsobject(Contact Form Options)required

contact_form_options.contact_form_idstring(Contact Form)^rolodex-contacts__.*required

The default contact form to present to the user to verify the contact info before proceeding

contact_form_options.htmlstring(Html)

Text to show on the top of the form

custom_field_valuesArray of objects(Custom Field Values)

descriptionstring(Description)

The description of the process

display_in_portalboolean(Display In Portal)

Whether this process is available in the portal

display_in_portal_asstring(Display In Portal As)required

How to display in portal

display_ordernumber(float)(Display Order)

The order to display

enable_confirmation_emailboolean(Enable Confirmation Email)

Whether or not to send an email when the job posting is processed

enable_expiration_notification_emailboolean(Enable Expiration Notification Email)

Whether or not to send an email when the job posting has expired

enable_job_editingboolean(Enable Job Editing)

If true, job posters can edit jobs in the portal

expiration_notification_emailobject(Expiration Notification Email)required

Email to send once the job posting has expired and has been taken down

expiration_notification_email.bccstring(Bcc)

Anyone that should be bcc'ed on the email

expiration_notification_email.bodystring(Body)required

The email body

expiration_notification_email.ccstring(Cc)

Anyone that should be cc'ed on the email

expiration_notification_email.fromstring(From)

From email address

expiration_notification_email.from_namestring(From Name)

From name

expiration_notification_email.reply_tostring(Reply To)

The reply to

expiration_notification_email.subjectstring(Subject)required

The email subject

form_idstring(Form)careers-job-postings__.*required

The job posting form

idstring(ID)^[\w|-]+$required

The unique, string identifier of this job posting process

is_activeboolean(Is Active)

Whether or not this job posting process is active

job_editing_form_idstring(Job Editing Form)careers-job-postings__.*required

The job posting form

jobs_require_approvalboolean(Jobs Require Approval)

If set, jobs posted using this process require approval

namestring(Name)required

The name of the job posting process

organization_form_optionsobject(Organization Form Options)required

organization_form_options.htmlstring(Html)

Text to show on the top of the form

organization_form_options.organization_form_idstring(Organization Form)^rolodex-organizations__.*required

The default organization form to present to the user to verify the organization info before proceeding

posting_expirationnumber(float)(Posting Expiration)required

The default expiration of job postings posted during this process in days

show_contact_formboolean(Show Contact Form)

Whether or not to show a contact form

show_organization_formboolean(Show Organization Form)

Whether or not to show an organization form

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response

application/json

{
  "confirmation_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "contact_form_options": {
    "contact_form_id": "string",
    "html": "string"
  },
  "custom_field_values": [
    { … }
  ],
  "description": "string",
  "display_in_portal": true,
  "display_in_portal_as": "string",
  "display_order": 0.1,
  "enable_confirmation_email": true,
  "enable_expiration_notification_email": true,
  "enable_job_editing": true,
  "expiration_notification_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "form_id": "string",
  "id": "string",
  "is_active": true,
  "job_editing_form_id": "string",
  "jobs_require_approval": true,
  "name": "string",
  "organization_form_options": {
    "html": "string",
    "organization_form_id": "string"
  },
  "posting_expiration": 0.1,
  "show_contact_form": true,
  "show_organization_form": true,
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1
}

Job Posting Types

Operations

Job Postings

Operations

Packages

Operations

Query Definitions

Operations

Resume Banks

Operations

Resumes

Operations

Settings

Operations

Statistics

Operations

Career Center (v1-2025-04-18)

Employer Profiles

Job Boards

Job Posting Applications

Job Posting Processes

Gets all of the job posting processes in the system.

Request

Responses

Was this helpful?

Creates a new job posting process record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a job posting process from the system by its ID.

Request

Responses

Was this helpful?

Returns a job posting process from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a job posting process with the specified ID.

Request

Responses

Was this helpful?

Updates a job posting process with the specified ID.

RequestExpand all

Responses

Was this helpful?

Job Posting Types

Job Postings

Packages

Query Definitions

Resume Banks

Resumes

Settings

Statistics

Request

Request

Request