Career Center (v1-2025-04-18)

Service providing access to Career Center resources and features

Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/
https://careers.api.rhythmsoftware.com/

Employer Profiles

Employer Profiles

Operations

Job Boards

Job Boards

Operations

Job Posting Applications

Job Posting Applications

Operations

Job Posting Processes

Job Posting Processes

Operations

Job Posting Types

Job Posting Types

Operations

Job Postings

Job Postings

Operations

Packages

Packages

Operations

Gets all of the packages in the system.

Request

This method will scan all packages 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/packages/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The packageswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bulk_pricing_rulesArray of objectsnon-emptyrequired
bulk_pricing_rules[].​discount_amountnumber(float)(Discount Amount)>= 0required

The percentage/flat rate

bulk_pricing_rules[].​discount_typestring(Discount Type)required

The type of discount rule

Enum"flat rate""percentage"
bulk_pricing_rules[].​ending_rangeinteger(Ending Range)>= 0

The ending range of the rule

bulk_pricing_rules[].​starting_rangeinteger(Starting Range)>= 0

The starting range of the rule

bundled_productsArray of objectsnon-emptyrequired
bundled_products[].​member_pricenumber(double)(Member Price)

The member price

bundled_products[].​pricenumber(double)(Price)

The price to bundle

bundled_products[].​product_idstring(Product)required

The product ID

bundled_products[].​product_typestring(Product Type)required

The product type

bundled_products[].​quantityinteger(Quantity)required

The quantity to bundle

bundled_products[].​typestring(Type)required
Enum"bundled product""inline bundled product"
bundled_products_inventory_handlingstring(Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum"bundle""each product"
business_unit_idstring(Business Unit)required

The business unit of the product

cancellation_feenumber(double)(Cancellation Fee)

Cancellation fees associated with this product

commerce_entitlements_to_createArray of objects
coupon_codesArray of objectsnon-emptyrequired
coupon_codes[].​coupon_code_generation_process_idstring(Coupon Code Generation Process)required

The process by which the coupons are generated

coupon_codes[].​coupon_code_typestring(Coupon Code Type)required
Enum"multi use""single use"
coupon_codes[].​coupon_idstring(Coupon)required
coupon_codes[].​coupon_typestring(Coupon Type)required
coupon_codes[].​expiration_dateExpiration Date (string)(date-time)(Expiration Date)
One of:
string(date-time)(Expiration Date)
coupon_codes[].​expiration_typestring(Expiration Type)
Enum"none""relative date""specific date"
coupon_codes[].​maximum_number_of_total_usesMaximum Number Of Total Uses (integer)(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

One of:

The maximum number of total uses

>= 1
integer(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

Value1
coupon_codes[].​maximum_number_of_uses_per_customerMaximum Number Of Uses Per Customer (integer)(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

One of:

The maximum number of total uses for a given customer

>= 1
integer(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

Value1
coupon_codes[].​quantityinteger(Quantity)<= 250required

The number of coupons to generate

coupon_codes[].​relative_expiration_dateRelative Expiration Date (object)(Relative Expiration Date)

Expiration date relative to purchase

One of:

Expiration date relative to purchase

coupon_codes[].​restrict_to_contactboolean(Restrict To Contact)

If true, the code generated is restricted to the contact who made the purchase

coupon_codes[].​restrict_to_organizationboolean(Restrict To Organization)

If true, the code generated is restricted to the organization made the purchase

custom_field_valuesArray of objects(Custom Field Values)
custom_pricing_optionsobject(Custom Pricing Options)required
custom_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

descriptionstring(Description)

Product description to be displayed on the portal

display_ordernumber(float)(Display Order)

The product display order

document_entitlements_to_createArray of objects
enable_bulk_pricingboolean(Enable Bulk Pricing)

Whether or not bulk pricing is enabled

enable_bundled_productsboolean(Enable Bundled Products)

Whether to enable bundled products

enable_cancellation_feesboolean(Enable Cancellation Fees)

Whether or not cancellation fees are applicable

enable_commerce_entitlement_creationboolean(Enable Commerce Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_coupon_code_generationboolean(Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

enable_custom_pricingboolean(Enable Custom Pricing)

If set, the order engine will call out to a custom lambda function for custom/complex pricing

enable_document_entitlement_creationboolean(Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_product_confirmation_emailboolean(Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

enable_purchase_limitsboolean(Enable Purchase Limits)

If true, purchase limits are in place for this product

enable_purchasing_eligibilityboolean(Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

enable_special_pricesboolean(Enable Special Prices)

Whether to enable special pricing logic

enable_task_generationboolean(Enable Task Generation)

If set, tasks will be generated

foreign_currency_pricesArray of objects
grant_job_postingsboolean(Grant Job Postings)

Whether or not purchasers of this product should get job postings

grant_resume_accessboolean(Grant Resume Access)

If set, purchasers of this package will be able to access a resume bank

hide_from_portalboolean(Hide From Portal)

If set, this product should not be shown in the portal

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

The unique, string identifier of this miscellaneous product

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

is_activeboolean(Is Active)

Whether this product is active/used

job_posting_optionsobject(Job Posting Options)required
job_posting_options.​number_of_postingsnumber(float)(Number Of Postings)required

Number of postings to grant

member_pricenumber(double)(Member Price)

The price of the product for an active member

namestring(Name)required

The name of the miscellaneous product

notesstring(Notes)

Notes

portal_optionsobject(Portal Options)
pricenumber(double)(Price)required

The price of the product

product_confirmation_email_optionsobject(Product Confirmation Email Options)required
product_confirmation_email_options.​product_confirmation_email_idProduct Confirmation Email (string)(Product Confirmation Email)
One of:
string(Product Confirmation Email)
product_confirmation_email_options.​product_specific_emailProduct Specific Email (object)(Product Specific Email)
One of:
product_confirmation_email_options.​typestring(Type)
Enum"product specific""shared"
publish_to_portalboolean(Publish To Portal)

Whether or not this product should be available in the portal

purchase_limitsobject(Purchase Limits)required
purchase_limits.​error_messagestring(Error Message)

The error message to show

purchase_limits.​maximumnumber(float)(Maximum)required

The maximum

purchase_limits.​relative_time_windowRelative Time Window (object)(Relative Time Window)

the time window

One of:

the time window

purchase_limits.​time_periodstring(Time Period)required
Enum"all time""sliding time window"
purchase_limits.​typestring(Type)required
Value"per customer"
purchasing_eligibility_criteriaobject(Purchasing Eligibility Criteria)
resume_banksArray of objects
special_pricesArray of objectsnon-emptyrequired
special_prices[].​criteriaobject(Criteria)required
special_prices[].​enable_formulaboolean(Enable Formula)

if set, a formula is used to calculate the price. If the formula fails, the price is used

special_prices[].​formulaFormula (string)(Formula)

The formula evaluated using the expr-eval npm package

One of:

The formula evaluated using the expr-eval npm package

string(Formula)

The formula evaluated using the expr-eval npm package

special_prices[].​namestring(Name)
special_prices[].​pricenumber(float)(Price)required
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

tasks_to_generateArray of objects
typestring(Type)

The product type

Value"careers-packages"
]
Response
application/json
[ { "allow_customer_to_choose_installment_plan": true, "bulk_pricing_rules": [], "bundled_products": [], "bundled_products_inventory_handling": "bundle", "business_unit_id": "string", "cancellation_fee": 0.1, "commerce_entitlements_to_create": [], "coupon_codes": [], "custom_field_values": [], "custom_pricing_options": {}, "description": "string", "display_order": 0.1, "document_entitlements_to_create": [], "enable_bulk_pricing": true, "enable_bundled_products": true, "enable_cancellation_fees": true, "enable_commerce_entitlement_creation": true, "enable_coupon_code_generation": true, "enable_custom_pricing": true, "enable_document_entitlement_creation": true, "enable_product_confirmation_email": true, "enable_purchase_limits": true, "enable_purchasing_eligibility": true, "enable_special_prices": true, "enable_task_generation": true, "foreign_currency_prices": [], "grant_job_postings": true, "grant_resume_access": true, "hide_from_portal": true, "id": "string", "installment_plan_options": [], "is_active": true, "job_posting_options": {}, "member_price": 0.1, "name": "string", "notes": "string", "portal_options": {}, "price": 0.1, "product_confirmation_email_options": {}, "publish_to_portal": true, "purchase_limits": {}, "purchasing_eligibility_criteria": {}, "resume_banks": [], "special_prices": [], "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, "tasks_to_generate": [], "type": "careers-packages" } ]

Creates a new package record that does not already exist.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The package that you would like to be saved.

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bulk_pricing_rulesArray of objectsnon-emptyrequired
bulk_pricing_rules[].​discount_amountnumber(float)(Discount Amount)>= 0required

The percentage/flat rate

bulk_pricing_rules[].​discount_typestring(Discount Type)required

The type of discount rule

Enum"flat rate""percentage"
bulk_pricing_rules[].​ending_rangeinteger(Ending Range)>= 0

The ending range of the rule

bulk_pricing_rules[].​starting_rangeinteger(Starting Range)>= 0

The starting range of the rule

bundled_productsArray of objectsnon-emptyrequired
bundled_products[].​member_pricenumber(double)(Member Price)

The member price

bundled_products[].​pricenumber(double)(Price)

The price to bundle

bundled_products[].​product_idstring(Product)required

The product ID

bundled_products[].​product_typestring(Product Type)required

The product type

bundled_products[].​quantityinteger(Quantity)required

The quantity to bundle

bundled_products[].​typestring(Type)required
Enum"bundled product""inline bundled product"
bundled_products_inventory_handlingstring(Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum"bundle""each product"
business_unit_idstring(Business Unit)required

The business unit of the product

cancellation_feenumber(double)(Cancellation Fee)

Cancellation fees associated with this product

commerce_entitlements_to_createArray of objects
coupon_codesArray of objectsnon-emptyrequired
coupon_codes[].​coupon_code_generation_process_idstring(Coupon Code Generation Process)required

The process by which the coupons are generated

coupon_codes[].​coupon_code_typestring(Coupon Code Type)required
Enum"multi use""single use"
coupon_codes[].​coupon_idstring(Coupon)required
coupon_codes[].​coupon_typestring(Coupon Type)required
coupon_codes[].​expiration_dateExpiration Date (string)(date-time)(Expiration Date)
One of:
string(date-time)(Expiration Date)
coupon_codes[].​expiration_typestring(Expiration Type)
Enum"none""relative date""specific date"
coupon_codes[].​maximum_number_of_total_usesMaximum Number Of Total Uses (integer)(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

One of:

The maximum number of total uses

>= 1
integer(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

Value1
coupon_codes[].​maximum_number_of_uses_per_customerMaximum Number Of Uses Per Customer (integer)(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

One of:

The maximum number of total uses for a given customer

>= 1
integer(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

Value1
coupon_codes[].​quantityinteger(Quantity)<= 250required

The number of coupons to generate

coupon_codes[].​relative_expiration_dateRelative Expiration Date (object)(Relative Expiration Date)

Expiration date relative to purchase

One of:

Expiration date relative to purchase

coupon_codes[].​restrict_to_contactboolean(Restrict To Contact)

If true, the code generated is restricted to the contact who made the purchase

coupon_codes[].​restrict_to_organizationboolean(Restrict To Organization)

If true, the code generated is restricted to the organization made the purchase

custom_field_valuesArray of objects(Custom Field Values)
custom_pricing_optionsobject(Custom Pricing Options)required
custom_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

descriptionstring(Description)

Product description to be displayed on the portal

display_ordernumber(float)(Display Order)

The product display order

document_entitlements_to_createArray of objects
enable_bulk_pricingboolean(Enable Bulk Pricing)

Whether or not bulk pricing is enabled

enable_bundled_productsboolean(Enable Bundled Products)

Whether to enable bundled products

enable_cancellation_feesboolean(Enable Cancellation Fees)

Whether or not cancellation fees are applicable

enable_commerce_entitlement_creationboolean(Enable Commerce Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_coupon_code_generationboolean(Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

enable_custom_pricingboolean(Enable Custom Pricing)

If set, the order engine will call out to a custom lambda function for custom/complex pricing

enable_document_entitlement_creationboolean(Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_product_confirmation_emailboolean(Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

enable_purchase_limitsboolean(Enable Purchase Limits)

If true, purchase limits are in place for this product

enable_purchasing_eligibilityboolean(Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

enable_special_pricesboolean(Enable Special Prices)

Whether to enable special pricing logic

enable_task_generationboolean(Enable Task Generation)

If set, tasks will be generated

foreign_currency_pricesArray of objects
grant_job_postingsboolean(Grant Job Postings)

Whether or not purchasers of this product should get job postings

grant_resume_accessboolean(Grant Resume Access)

If set, purchasers of this package will be able to access a resume bank

hide_from_portalboolean(Hide From Portal)

If set, this product should not be shown in the portal

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

The unique, string identifier of this miscellaneous product

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

is_activeboolean(Is Active)

Whether this product is active/used

job_posting_optionsobject(Job Posting Options)required
job_posting_options.​number_of_postingsnumber(float)(Number Of Postings)required

Number of postings to grant

member_pricenumber(double)(Member Price)

The price of the product for an active member

namestring(Name)required

The name of the miscellaneous product

notesstring(Notes)

Notes

portal_optionsobject(Portal Options)
pricenumber(double)(Price)required

The price of the product

product_confirmation_email_optionsobject(Product Confirmation Email Options)required
product_confirmation_email_options.​product_confirmation_email_idProduct Confirmation Email (string)(Product Confirmation Email)
One of:
string(Product Confirmation Email)
product_confirmation_email_options.​product_specific_emailProduct Specific Email (object)(Product Specific Email)
One of:
product_confirmation_email_options.​typestring(Type)
Enum"product specific""shared"
publish_to_portalboolean(Publish To Portal)

Whether or not this product should be available in the portal

purchase_limitsobject(Purchase Limits)required
purchase_limits.​error_messagestring(Error Message)

The error message to show

purchase_limits.​maximumnumber(float)(Maximum)required

The maximum

purchase_limits.​relative_time_windowRelative Time Window (object)(Relative Time Window)

the time window

One of:

the time window

purchase_limits.​time_periodstring(Time Period)required
Enum"all time""sliding time window"
purchase_limits.​typestring(Type)required
Value"per customer"
purchasing_eligibility_criteriaobject(Purchasing Eligibility Criteria)
resume_banksArray of objects
special_pricesArray of objectsnon-emptyrequired
special_prices[].​criteriaobject(Criteria)required
special_prices[].​enable_formulaboolean(Enable Formula)

if set, a formula is used to calculate the price. If the formula fails, the price is used

special_prices[].​formulaFormula (string)(Formula)

The formula evaluated using the expr-eval npm package

One of:

The formula evaluated using the expr-eval npm package

string(Formula)

The formula evaluated using the expr-eval npm package

special_prices[].​namestring(Name)
special_prices[].​pricenumber(float)(Price)required
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

tasks_to_generateArray of objects
typestring(Type)

The product type

Value"careers-packages"
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/packages/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow_customer_to_choose_installment_plan": true,
    "bulk_pricing_rules": [
      {
        "discount_amount": 0.1,
        "discount_type": "flat rate",
        "ending_range": 0,
        "starting_range": 0
      }
    ],
    "bundled_products": [
      {
        "member_price": 0.1,
        "price": 0.1,
        "product_id": "string",
        "product_type": "string",
        "quantity": 0,
        "type": "bundled product"
      }
    ],
    "bundled_products_inventory_handling": "bundle",
    "business_unit_id": "string",
    "cancellation_fee": 0.1,
    "commerce_entitlements_to_create": [
      {
        "expiration_date": null,
        "expiration_type": "none",
        "quantity": 0.1,
        "relative_expiration_date": {
          "number": null,
          "position": "after",
          "relative_to": "the beginning of the month",
          "unit_of_time": "days"
        },
        "type_id": "string"
      }
    ],
    "coupon_codes": [
      {
        "coupon_code_generation_process_id": "string",
        "coupon_code_type": "multi use",
        "coupon_id": "string",
        "coupon_type": "string",
        "expiration_date": null,
        "expiration_type": "none",
        "maximum_number_of_total_uses": 1,
        "maximum_number_of_uses_per_customer": 1,
        "quantity": 250,
        "relative_expiration_date": {
          "number": null,
          "position": "after",
          "relative_to": "the beginning of the month",
          "unit_of_time": "days"
        },
        "restrict_to_contact": true,
        "restrict_to_organization": true
      }
    ],
    "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": [
          {}
        ]
      }
    ],
    "custom_pricing_options": {
      "lambda_function_id": "string"
    },
    "description": "string",
    "display_order": 0.1,
    "document_entitlements_to_create": [
      {
        "expiration_date": null,
        "expiration_type": "none",
        "file_cabinet_id": "string",
        "item_id": "string",
        "library_path": "string",
        "relative_expiration_date": {
          "number": null,
          "position": "after",
          "relative_to": "the beginning of the month",
          "unit_of_time": "days"
        }
      }
    ],
    "enable_bulk_pricing": true,
    "enable_bundled_products": true,
    "enable_cancellation_fees": true,
    "enable_commerce_entitlement_creation": true,
    "enable_coupon_code_generation": true,
    "enable_custom_pricing": true,
    "enable_document_entitlement_creation": true,
    "enable_product_confirmation_email": true,
    "enable_purchase_limits": true,
    "enable_purchasing_eligibility": true,
    "enable_special_prices": true,
    "enable_task_generation": true,
    "foreign_currency_prices": [
      {
        "cancellation_fee": 0.1,
        "currency_code": "AED",
        "member_price": 0.1,
        "mode": "calculate price",
        "price": null,
        "restocking_fee": 0.1
      }
    ],
    "grant_job_postings": true,
    "grant_resume_access": true,
    "hide_from_portal": true,
    "id": "string",
    "installment_plan_options": [
      {
        "additional_cost": 0.1,
        "installment_plan_id": "string",
        "is_default": true
      }
    ],
    "is_active": true,
    "job_posting_options": {
      "number_of_postings": 0.1
    },
    "member_price": 0.1,
    "name": "string",
    "notes": "string",
    "portal_options": {
      "available_from": "2019-08-24T14:15:22Z",
      "available_until": "2019-08-24T14:15:22Z"
    },
    "price": 0.1,
    "product_confirmation_email_options": {
      "product_confirmation_email_id": null,
      "product_specific_email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "type": "product specific"
    },
    "publish_to_portal": true,
    "purchase_limits": {
      "error_message": "string",
      "maximum": 0.1,
      "relative_time_window": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "time_period": "all time",
      "type": "per customer"
    },
    "purchasing_eligibility_criteria": {},
    "resume_banks": [
      {
        "expiration_in_days": 0.1,
        "grant_access": true,
        "resume_bank_id": "string"
      }
    ],
    "special_prices": [
      {
        "criteria": {},
        "enable_formula": true,
        "formula": null,
        "name": "string",
        "price": 0.1
      }
    ],
    "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,
    "tasks_to_generate": [
      {
        "assignee_type": "assignment role",
        "assignment_role_id": null,
        "description": "string",
        "due_date_type": "none",
        "name": "string",
        "notify_assignees": true,
        "priority": "high",
        "queue_id": null,
        "relative_due_date": {
          "number": null,
          "position": "after",
          "relative_to": "the beginning of the month",
          "unit_of_time": "days"
        },
        "specific_due_date": null,
        "type_id": "string",
        "user_id": null
      }
    ],
    "type": "careers-packages"
  }'

Responses

The package was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bulk_pricing_rulesArray of objectsnon-emptyrequired
bulk_pricing_rules[].​discount_amountnumber(float)(Discount Amount)>= 0required

The percentage/flat rate

bulk_pricing_rules[].​discount_typestring(Discount Type)required

The type of discount rule

Enum"flat rate""percentage"
bulk_pricing_rules[].​ending_rangeinteger(Ending Range)>= 0

The ending range of the rule

bulk_pricing_rules[].​starting_rangeinteger(Starting Range)>= 0

The starting range of the rule

bundled_productsArray of objectsnon-emptyrequired
bundled_products[].​member_pricenumber(double)(Member Price)

The member price

bundled_products[].​pricenumber(double)(Price)

The price to bundle

bundled_products[].​product_idstring(Product)required

The product ID

bundled_products[].​product_typestring(Product Type)required

The product type

bundled_products[].​quantityinteger(Quantity)required

The quantity to bundle

bundled_products[].​typestring(Type)required
Enum"bundled product""inline bundled product"
bundled_products_inventory_handlingstring(Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum"bundle""each product"
business_unit_idstring(Business Unit)required

The business unit of the product

cancellation_feenumber(double)(Cancellation Fee)

Cancellation fees associated with this product

commerce_entitlements_to_createArray of objects
coupon_codesArray of objectsnon-emptyrequired
coupon_codes[].​coupon_code_generation_process_idstring(Coupon Code Generation Process)required

The process by which the coupons are generated

coupon_codes[].​coupon_code_typestring(Coupon Code Type)required
Enum"multi use""single use"
coupon_codes[].​coupon_idstring(Coupon)required
coupon_codes[].​coupon_typestring(Coupon Type)required
coupon_codes[].​expiration_dateExpiration Date (string)(date-time)(Expiration Date)
One of:
string(date-time)(Expiration Date)
coupon_codes[].​expiration_typestring(Expiration Type)
Enum"none""relative date""specific date"
coupon_codes[].​maximum_number_of_total_usesMaximum Number Of Total Uses (integer)(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

One of:

The maximum number of total uses

>= 1
integer(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

Value1
coupon_codes[].​maximum_number_of_uses_per_customerMaximum Number Of Uses Per Customer (integer)(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

One of:

The maximum number of total uses for a given customer

>= 1
integer(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

Value1
coupon_codes[].​quantityinteger(Quantity)<= 250required

The number of coupons to generate

coupon_codes[].​relative_expiration_dateRelative Expiration Date (object)(Relative Expiration Date)

Expiration date relative to purchase

One of:

Expiration date relative to purchase

coupon_codes[].​restrict_to_contactboolean(Restrict To Contact)

If true, the code generated is restricted to the contact who made the purchase

coupon_codes[].​restrict_to_organizationboolean(Restrict To Organization)

If true, the code generated is restricted to the organization made the purchase

custom_field_valuesArray of objects(Custom Field Values)
custom_pricing_optionsobject(Custom Pricing Options)required
custom_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

descriptionstring(Description)

Product description to be displayed on the portal

display_ordernumber(float)(Display Order)

The product display order

document_entitlements_to_createArray of objects
enable_bulk_pricingboolean(Enable Bulk Pricing)

Whether or not bulk pricing is enabled

enable_bundled_productsboolean(Enable Bundled Products)

Whether to enable bundled products

enable_cancellation_feesboolean(Enable Cancellation Fees)

Whether or not cancellation fees are applicable

enable_commerce_entitlement_creationboolean(Enable Commerce Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_coupon_code_generationboolean(Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

enable_custom_pricingboolean(Enable Custom Pricing)

If set, the order engine will call out to a custom lambda function for custom/complex pricing

enable_document_entitlement_creationboolean(Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_product_confirmation_emailboolean(Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

enable_purchase_limitsboolean(Enable Purchase Limits)

If true, purchase limits are in place for this product

enable_purchasing_eligibilityboolean(Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

enable_special_pricesboolean(Enable Special Prices)

Whether to enable special pricing logic

enable_task_generationboolean(Enable Task Generation)

If set, tasks will be generated

foreign_currency_pricesArray of objects
grant_job_postingsboolean(Grant Job Postings)

Whether or not purchasers of this product should get job postings

grant_resume_accessboolean(Grant Resume Access)

If set, purchasers of this package will be able to access a resume bank

hide_from_portalboolean(Hide From Portal)

If set, this product should not be shown in the portal

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

The unique, string identifier of this miscellaneous product

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

is_activeboolean(Is Active)

Whether this product is active/used

job_posting_optionsobject(Job Posting Options)required
job_posting_options.​number_of_postingsnumber(float)(Number Of Postings)required

Number of postings to grant

member_pricenumber(double)(Member Price)

The price of the product for an active member

namestring(Name)required

The name of the miscellaneous product

notesstring(Notes)

Notes

portal_optionsobject(Portal Options)
pricenumber(double)(Price)required

The price of the product

product_confirmation_email_optionsobject(Product Confirmation Email Options)required
product_confirmation_email_options.​product_confirmation_email_idProduct Confirmation Email (string)(Product Confirmation Email)
One of:
string(Product Confirmation Email)
product_confirmation_email_options.​product_specific_emailProduct Specific Email (object)(Product Specific Email)
One of:
product_confirmation_email_options.​typestring(Type)
Enum"product specific""shared"
publish_to_portalboolean(Publish To Portal)

Whether or not this product should be available in the portal

purchase_limitsobject(Purchase Limits)required
purchase_limits.​error_messagestring(Error Message)

The error message to show

purchase_limits.​maximumnumber(float)(Maximum)required

The maximum

purchase_limits.​relative_time_windowRelative Time Window (object)(Relative Time Window)

the time window

One of:

the time window

purchase_limits.​time_periodstring(Time Period)required
Enum"all time""sliding time window"
purchase_limits.​typestring(Type)required
Value"per customer"
purchasing_eligibility_criteriaobject(Purchasing Eligibility Criteria)
resume_banksArray of objects
special_pricesArray of objectsnon-emptyrequired
special_prices[].​criteriaobject(Criteria)required
special_prices[].​enable_formulaboolean(Enable Formula)

if set, a formula is used to calculate the price. If the formula fails, the price is used

special_prices[].​formulaFormula (string)(Formula)

The formula evaluated using the expr-eval npm package

One of:

The formula evaluated using the expr-eval npm package

string(Formula)

The formula evaluated using the expr-eval npm package

special_prices[].​namestring(Name)
special_prices[].​pricenumber(float)(Price)required
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

tasks_to_generateArray of objects
typestring(Type)

The product type

Value"careers-packages"
Response
application/json
{ "allow_customer_to_choose_installment_plan": true, "bulk_pricing_rules": [ {} ], "bundled_products": [ {} ], "bundled_products_inventory_handling": "bundle", "business_unit_id": "string", "cancellation_fee": 0.1, "commerce_entitlements_to_create": [ {} ], "coupon_codes": [ {} ], "custom_field_values": [ {} ], "custom_pricing_options": { "lambda_function_id": "string" }, "description": "string", "display_order": 0.1, "document_entitlements_to_create": [ {} ], "enable_bulk_pricing": true, "enable_bundled_products": true, "enable_cancellation_fees": true, "enable_commerce_entitlement_creation": true, "enable_coupon_code_generation": true, "enable_custom_pricing": true, "enable_document_entitlement_creation": true, "enable_product_confirmation_email": true, "enable_purchase_limits": true, "enable_purchasing_eligibility": true, "enable_special_prices": true, "enable_task_generation": true, "foreign_currency_prices": [ {} ], "grant_job_postings": true, "grant_resume_access": true, "hide_from_portal": true, "id": "string", "installment_plan_options": [ {} ], "is_active": true, "job_posting_options": { "number_of_postings": 0.1 }, "member_price": 0.1, "name": "string", "notes": "string", "portal_options": { "available_from": "2019-08-24T14:15:22Z", "available_until": "2019-08-24T14:15:22Z" }, "price": 0.1, "product_confirmation_email_options": { "product_confirmation_email_id": null, "product_specific_email": {}, "type": "product specific" }, "publish_to_portal": true, "purchase_limits": { "error_message": "string", "maximum": 0.1, "relative_time_window": {}, "time_period": "all time", "type": "per customer" }, "purchasing_eligibility_criteria": {}, "resume_banks": [ {} ], "special_prices": [ {} ], "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, "tasks_to_generate": [ {} ], "type": "careers-packages" }

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/packages/{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 package from the system by its ID.

Request

This method will delete a package with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the package to delete.

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

Responses

The package 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 package from the system by its ID.

Request

This method will look up a package by the specified ID and return it back.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the package 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/packages/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The package was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bulk_pricing_rulesArray of objectsnon-emptyrequired
bulk_pricing_rules[].​discount_amountnumber(float)(Discount Amount)>= 0required

The percentage/flat rate

bulk_pricing_rules[].​discount_typestring(Discount Type)required

The type of discount rule

Enum"flat rate""percentage"
bulk_pricing_rules[].​ending_rangeinteger(Ending Range)>= 0

The ending range of the rule

bulk_pricing_rules[].​starting_rangeinteger(Starting Range)>= 0

The starting range of the rule

bundled_productsArray of objectsnon-emptyrequired
bundled_products[].​member_pricenumber(double)(Member Price)

The member price

bundled_products[].​pricenumber(double)(Price)

The price to bundle

bundled_products[].​product_idstring(Product)required

The product ID

bundled_products[].​product_typestring(Product Type)required

The product type

bundled_products[].​quantityinteger(Quantity)required

The quantity to bundle

bundled_products[].​typestring(Type)required
Enum"bundled product""inline bundled product"
bundled_products_inventory_handlingstring(Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum"bundle""each product"
business_unit_idstring(Business Unit)required

The business unit of the product

cancellation_feenumber(double)(Cancellation Fee)

Cancellation fees associated with this product

commerce_entitlements_to_createArray of objects
coupon_codesArray of objectsnon-emptyrequired
coupon_codes[].​coupon_code_generation_process_idstring(Coupon Code Generation Process)required

The process by which the coupons are generated

coupon_codes[].​coupon_code_typestring(Coupon Code Type)required
Enum"multi use""single use"
coupon_codes[].​coupon_idstring(Coupon)required
coupon_codes[].​coupon_typestring(Coupon Type)required
coupon_codes[].​expiration_dateExpiration Date (string)(date-time)(Expiration Date)
One of:
string(date-time)(Expiration Date)
coupon_codes[].​expiration_typestring(Expiration Type)
Enum"none""relative date""specific date"
coupon_codes[].​maximum_number_of_total_usesMaximum Number Of Total Uses (integer)(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

One of:

The maximum number of total uses

>= 1
integer(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

Value1
coupon_codes[].​maximum_number_of_uses_per_customerMaximum Number Of Uses Per Customer (integer)(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

One of:

The maximum number of total uses for a given customer

>= 1
integer(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

Value1
coupon_codes[].​quantityinteger(Quantity)<= 250required

The number of coupons to generate

coupon_codes[].​relative_expiration_dateRelative Expiration Date (object)(Relative Expiration Date)

Expiration date relative to purchase

One of:

Expiration date relative to purchase

coupon_codes[].​restrict_to_contactboolean(Restrict To Contact)

If true, the code generated is restricted to the contact who made the purchase

coupon_codes[].​restrict_to_organizationboolean(Restrict To Organization)

If true, the code generated is restricted to the organization made the purchase

custom_field_valuesArray of objects(Custom Field Values)
custom_pricing_optionsobject(Custom Pricing Options)required
custom_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

descriptionstring(Description)

Product description to be displayed on the portal

display_ordernumber(float)(Display Order)

The product display order

document_entitlements_to_createArray of objects
enable_bulk_pricingboolean(Enable Bulk Pricing)

Whether or not bulk pricing is enabled

enable_bundled_productsboolean(Enable Bundled Products)

Whether to enable bundled products

enable_cancellation_feesboolean(Enable Cancellation Fees)

Whether or not cancellation fees are applicable

enable_commerce_entitlement_creationboolean(Enable Commerce Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_coupon_code_generationboolean(Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

enable_custom_pricingboolean(Enable Custom Pricing)

If set, the order engine will call out to a custom lambda function for custom/complex pricing

enable_document_entitlement_creationboolean(Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_product_confirmation_emailboolean(Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

enable_purchase_limitsboolean(Enable Purchase Limits)

If true, purchase limits are in place for this product

enable_purchasing_eligibilityboolean(Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

enable_special_pricesboolean(Enable Special Prices)

Whether to enable special pricing logic

enable_task_generationboolean(Enable Task Generation)

If set, tasks will be generated

foreign_currency_pricesArray of objects
grant_job_postingsboolean(Grant Job Postings)

Whether or not purchasers of this product should get job postings

grant_resume_accessboolean(Grant Resume Access)

If set, purchasers of this package will be able to access a resume bank

hide_from_portalboolean(Hide From Portal)

If set, this product should not be shown in the portal

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

The unique, string identifier of this miscellaneous product

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

is_activeboolean(Is Active)

Whether this product is active/used

job_posting_optionsobject(Job Posting Options)required
job_posting_options.​number_of_postingsnumber(float)(Number Of Postings)required

Number of postings to grant

member_pricenumber(double)(Member Price)

The price of the product for an active member

namestring(Name)required

The name of the miscellaneous product

notesstring(Notes)

Notes

portal_optionsobject(Portal Options)
pricenumber(double)(Price)required

The price of the product

product_confirmation_email_optionsobject(Product Confirmation Email Options)required
product_confirmation_email_options.​product_confirmation_email_idProduct Confirmation Email (string)(Product Confirmation Email)
One of:
string(Product Confirmation Email)
product_confirmation_email_options.​product_specific_emailProduct Specific Email (object)(Product Specific Email)
One of:
product_confirmation_email_options.​typestring(Type)
Enum"product specific""shared"
publish_to_portalboolean(Publish To Portal)

Whether or not this product should be available in the portal

purchase_limitsobject(Purchase Limits)required
purchase_limits.​error_messagestring(Error Message)

The error message to show

purchase_limits.​maximumnumber(float)(Maximum)required

The maximum

purchase_limits.​relative_time_windowRelative Time Window (object)(Relative Time Window)

the time window

One of:

the time window

purchase_limits.​time_periodstring(Time Period)required
Enum"all time""sliding time window"
purchase_limits.​typestring(Type)required
Value"per customer"
purchasing_eligibility_criteriaobject(Purchasing Eligibility Criteria)
resume_banksArray of objects
special_pricesArray of objectsnon-emptyrequired
special_prices[].​criteriaobject(Criteria)required
special_prices[].​enable_formulaboolean(Enable Formula)

if set, a formula is used to calculate the price. If the formula fails, the price is used

special_prices[].​formulaFormula (string)(Formula)

The formula evaluated using the expr-eval npm package

One of:

The formula evaluated using the expr-eval npm package

string(Formula)

The formula evaluated using the expr-eval npm package

special_prices[].​namestring(Name)
special_prices[].​pricenumber(float)(Price)required
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

tasks_to_generateArray of objects
typestring(Type)

The product type

Value"careers-packages"
Response
application/json
{ "allow_customer_to_choose_installment_plan": true, "bulk_pricing_rules": [ {} ], "bundled_products": [ {} ], "bundled_products_inventory_handling": "bundle", "business_unit_id": "string", "cancellation_fee": 0.1, "commerce_entitlements_to_create": [ {} ], "coupon_codes": [ {} ], "custom_field_values": [ {} ], "custom_pricing_options": { "lambda_function_id": "string" }, "description": "string", "display_order": 0.1, "document_entitlements_to_create": [ {} ], "enable_bulk_pricing": true, "enable_bundled_products": true, "enable_cancellation_fees": true, "enable_commerce_entitlement_creation": true, "enable_coupon_code_generation": true, "enable_custom_pricing": true, "enable_document_entitlement_creation": true, "enable_product_confirmation_email": true, "enable_purchase_limits": true, "enable_purchasing_eligibility": true, "enable_special_prices": true, "enable_task_generation": true, "foreign_currency_prices": [ {} ], "grant_job_postings": true, "grant_resume_access": true, "hide_from_portal": true, "id": "string", "installment_plan_options": [ {} ], "is_active": true, "job_posting_options": { "number_of_postings": 0.1 }, "member_price": 0.1, "name": "string", "notes": "string", "portal_options": { "available_from": "2019-08-24T14:15:22Z", "available_until": "2019-08-24T14:15:22Z" }, "price": 0.1, "product_confirmation_email_options": { "product_confirmation_email_id": null, "product_specific_email": {}, "type": "product specific" }, "publish_to_portal": true, "purchase_limits": { "error_message": "string", "maximum": 0.1, "relative_time_window": {}, "time_period": "all time", "type": "per customer" }, "purchasing_eligibility_criteria": {}, "resume_banks": [ {} ], "special_prices": [ {} ], "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, "tasks_to_generate": [ {} ], "type": "careers-packages" }

Partially updates a package with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the package 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/packages/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The package was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bulk_pricing_rulesArray of objectsnon-emptyrequired
bulk_pricing_rules[].​discount_amountnumber(float)(Discount Amount)>= 0required

The percentage/flat rate

bulk_pricing_rules[].​discount_typestring(Discount Type)required

The type of discount rule

Enum"flat rate""percentage"
bulk_pricing_rules[].​ending_rangeinteger(Ending Range)>= 0

The ending range of the rule

bulk_pricing_rules[].​starting_rangeinteger(Starting Range)>= 0

The starting range of the rule

bundled_productsArray of objectsnon-emptyrequired
bundled_products[].​member_pricenumber(double)(Member Price)

The member price

bundled_products[].​pricenumber(double)(Price)

The price to bundle

bundled_products[].​product_idstring(Product)required

The product ID

bundled_products[].​product_typestring(Product Type)required

The product type

bundled_products[].​quantityinteger(Quantity)required

The quantity to bundle

bundled_products[].​typestring(Type)required
Enum"bundled product""inline bundled product"
bundled_products_inventory_handlingstring(Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum"bundle""each product"
business_unit_idstring(Business Unit)required

The business unit of the product

cancellation_feenumber(double)(Cancellation Fee)

Cancellation fees associated with this product

commerce_entitlements_to_createArray of objects
coupon_codesArray of objectsnon-emptyrequired
coupon_codes[].​coupon_code_generation_process_idstring(Coupon Code Generation Process)required

The process by which the coupons are generated

coupon_codes[].​coupon_code_typestring(Coupon Code Type)required
Enum"multi use""single use"
coupon_codes[].​coupon_idstring(Coupon)required
coupon_codes[].​coupon_typestring(Coupon Type)required
coupon_codes[].​expiration_dateExpiration Date (string)(date-time)(Expiration Date)
One of:
string(date-time)(Expiration Date)
coupon_codes[].​expiration_typestring(Expiration Type)
Enum"none""relative date""specific date"
coupon_codes[].​maximum_number_of_total_usesMaximum Number Of Total Uses (integer)(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

One of:

The maximum number of total uses

>= 1
integer(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

Value1
coupon_codes[].​maximum_number_of_uses_per_customerMaximum Number Of Uses Per Customer (integer)(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

One of:

The maximum number of total uses for a given customer

>= 1
integer(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

Value1
coupon_codes[].​quantityinteger(Quantity)<= 250required

The number of coupons to generate

coupon_codes[].​relative_expiration_dateRelative Expiration Date (object)(Relative Expiration Date)

Expiration date relative to purchase

One of:

Expiration date relative to purchase

coupon_codes[].​restrict_to_contactboolean(Restrict To Contact)

If true, the code generated is restricted to the contact who made the purchase

coupon_codes[].​restrict_to_organizationboolean(Restrict To Organization)

If true, the code generated is restricted to the organization made the purchase

custom_field_valuesArray of objects(Custom Field Values)
custom_pricing_optionsobject(Custom Pricing Options)required
custom_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

descriptionstring(Description)

Product description to be displayed on the portal

display_ordernumber(float)(Display Order)

The product display order

document_entitlements_to_createArray of objects
enable_bulk_pricingboolean(Enable Bulk Pricing)

Whether or not bulk pricing is enabled

enable_bundled_productsboolean(Enable Bundled Products)

Whether to enable bundled products

enable_cancellation_feesboolean(Enable Cancellation Fees)

Whether or not cancellation fees are applicable

enable_commerce_entitlement_creationboolean(Enable Commerce Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_coupon_code_generationboolean(Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

enable_custom_pricingboolean(Enable Custom Pricing)

If set, the order engine will call out to a custom lambda function for custom/complex pricing

enable_document_entitlement_creationboolean(Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_product_confirmation_emailboolean(Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

enable_purchase_limitsboolean(Enable Purchase Limits)

If true, purchase limits are in place for this product

enable_purchasing_eligibilityboolean(Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

enable_special_pricesboolean(Enable Special Prices)

Whether to enable special pricing logic

enable_task_generationboolean(Enable Task Generation)

If set, tasks will be generated

foreign_currency_pricesArray of objects
grant_job_postingsboolean(Grant Job Postings)

Whether or not purchasers of this product should get job postings

grant_resume_accessboolean(Grant Resume Access)

If set, purchasers of this package will be able to access a resume bank

hide_from_portalboolean(Hide From Portal)

If set, this product should not be shown in the portal

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

The unique, string identifier of this miscellaneous product

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

is_activeboolean(Is Active)

Whether this product is active/used

job_posting_optionsobject(Job Posting Options)required
job_posting_options.​number_of_postingsnumber(float)(Number Of Postings)required

Number of postings to grant

member_pricenumber(double)(Member Price)

The price of the product for an active member

namestring(Name)required

The name of the miscellaneous product

notesstring(Notes)

Notes

portal_optionsobject(Portal Options)
pricenumber(double)(Price)required

The price of the product

product_confirmation_email_optionsobject(Product Confirmation Email Options)required
product_confirmation_email_options.​product_confirmation_email_idProduct Confirmation Email (string)(Product Confirmation Email)
One of:
string(Product Confirmation Email)
product_confirmation_email_options.​product_specific_emailProduct Specific Email (object)(Product Specific Email)
One of:
product_confirmation_email_options.​typestring(Type)
Enum"product specific""shared"
publish_to_portalboolean(Publish To Portal)

Whether or not this product should be available in the portal

purchase_limitsobject(Purchase Limits)required
purchase_limits.​error_messagestring(Error Message)

The error message to show

purchase_limits.​maximumnumber(float)(Maximum)required

The maximum

purchase_limits.​relative_time_windowRelative Time Window (object)(Relative Time Window)

the time window

One of:

the time window

purchase_limits.​time_periodstring(Time Period)required
Enum"all time""sliding time window"
purchase_limits.​typestring(Type)required
Value"per customer"
purchasing_eligibility_criteriaobject(Purchasing Eligibility Criteria)
resume_banksArray of objects
special_pricesArray of objectsnon-emptyrequired
special_prices[].​criteriaobject(Criteria)required
special_prices[].​enable_formulaboolean(Enable Formula)

if set, a formula is used to calculate the price. If the formula fails, the price is used

special_prices[].​formulaFormula (string)(Formula)

The formula evaluated using the expr-eval npm package

One of:

The formula evaluated using the expr-eval npm package

string(Formula)

The formula evaluated using the expr-eval npm package

special_prices[].​namestring(Name)
special_prices[].​pricenumber(float)(Price)required
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

tasks_to_generateArray of objects
typestring(Type)

The product type

Value"careers-packages"
Response
application/json
{ "allow_customer_to_choose_installment_plan": true, "bulk_pricing_rules": [ {} ], "bundled_products": [ {} ], "bundled_products_inventory_handling": "bundle", "business_unit_id": "string", "cancellation_fee": 0.1, "commerce_entitlements_to_create": [ {} ], "coupon_codes": [ {} ], "custom_field_values": [ {} ], "custom_pricing_options": { "lambda_function_id": "string" }, "description": "string", "display_order": 0.1, "document_entitlements_to_create": [ {} ], "enable_bulk_pricing": true, "enable_bundled_products": true, "enable_cancellation_fees": true, "enable_commerce_entitlement_creation": true, "enable_coupon_code_generation": true, "enable_custom_pricing": true, "enable_document_entitlement_creation": true, "enable_product_confirmation_email": true, "enable_purchase_limits": true, "enable_purchasing_eligibility": true, "enable_special_prices": true, "enable_task_generation": true, "foreign_currency_prices": [ {} ], "grant_job_postings": true, "grant_resume_access": true, "hide_from_portal": true, "id": "string", "installment_plan_options": [ {} ], "is_active": true, "job_posting_options": { "number_of_postings": 0.1 }, "member_price": 0.1, "name": "string", "notes": "string", "portal_options": { "available_from": "2019-08-24T14:15:22Z", "available_until": "2019-08-24T14:15:22Z" }, "price": 0.1, "product_confirmation_email_options": { "product_confirmation_email_id": null, "product_specific_email": {}, "type": "product specific" }, "publish_to_portal": true, "purchase_limits": { "error_message": "string", "maximum": 0.1, "relative_time_window": {}, "time_period": "all time", "type": "per customer" }, "purchasing_eligibility_criteria": {}, "resume_banks": [ {} ], "special_prices": [ {} ], "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, "tasks_to_generate": [ {} ], "type": "careers-packages" }

Updates a package with the specified ID.

Request

This method will update an existing package with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the package to update.

Bodyapplication/jsonrequired

The updated package that will be saved.

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bulk_pricing_rulesArray of objectsnon-emptyrequired
bulk_pricing_rules[].​discount_amountnumber(float)(Discount Amount)>= 0required

The percentage/flat rate

bulk_pricing_rules[].​discount_typestring(Discount Type)required

The type of discount rule

Enum"flat rate""percentage"
bulk_pricing_rules[].​ending_rangeinteger(Ending Range)>= 0

The ending range of the rule

bulk_pricing_rules[].​starting_rangeinteger(Starting Range)>= 0

The starting range of the rule

bundled_productsArray of objectsnon-emptyrequired
bundled_products[].​member_pricenumber(double)(Member Price)

The member price

bundled_products[].​pricenumber(double)(Price)

The price to bundle

bundled_products[].​product_idstring(Product)required

The product ID

bundled_products[].​product_typestring(Product Type)required

The product type

bundled_products[].​quantityinteger(Quantity)required

The quantity to bundle

bundled_products[].​typestring(Type)required
Enum"bundled product""inline bundled product"
bundled_products_inventory_handlingstring(Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum"bundle""each product"
business_unit_idstring(Business Unit)required

The business unit of the product

cancellation_feenumber(double)(Cancellation Fee)

Cancellation fees associated with this product

commerce_entitlements_to_createArray of objects
coupon_codesArray of objectsnon-emptyrequired
coupon_codes[].​coupon_code_generation_process_idstring(Coupon Code Generation Process)required

The process by which the coupons are generated

coupon_codes[].​coupon_code_typestring(Coupon Code Type)required
Enum"multi use""single use"
coupon_codes[].​coupon_idstring(Coupon)required
coupon_codes[].​coupon_typestring(Coupon Type)required
coupon_codes[].​expiration_dateExpiration Date (string)(date-time)(Expiration Date)
One of:
string(date-time)(Expiration Date)
coupon_codes[].​expiration_typestring(Expiration Type)
Enum"none""relative date""specific date"
coupon_codes[].​maximum_number_of_total_usesMaximum Number Of Total Uses (integer)(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

One of:

The maximum number of total uses

>= 1
integer(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

Value1
coupon_codes[].​maximum_number_of_uses_per_customerMaximum Number Of Uses Per Customer (integer)(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

One of:

The maximum number of total uses for a given customer

>= 1
integer(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

Value1
coupon_codes[].​quantityinteger(Quantity)<= 250required

The number of coupons to generate

coupon_codes[].​relative_expiration_dateRelative Expiration Date (object)(Relative Expiration Date)

Expiration date relative to purchase

One of:

Expiration date relative to purchase

coupon_codes[].​restrict_to_contactboolean(Restrict To Contact)

If true, the code generated is restricted to the contact who made the purchase

coupon_codes[].​restrict_to_organizationboolean(Restrict To Organization)

If true, the code generated is restricted to the organization made the purchase

custom_field_valuesArray of objects(Custom Field Values)
custom_pricing_optionsobject(Custom Pricing Options)required
custom_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

descriptionstring(Description)

Product description to be displayed on the portal

display_ordernumber(float)(Display Order)

The product display order

document_entitlements_to_createArray of objects
enable_bulk_pricingboolean(Enable Bulk Pricing)

Whether or not bulk pricing is enabled

enable_bundled_productsboolean(Enable Bundled Products)

Whether to enable bundled products

enable_cancellation_feesboolean(Enable Cancellation Fees)

Whether or not cancellation fees are applicable

enable_commerce_entitlement_creationboolean(Enable Commerce Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_coupon_code_generationboolean(Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

enable_custom_pricingboolean(Enable Custom Pricing)

If set, the order engine will call out to a custom lambda function for custom/complex pricing

enable_document_entitlement_creationboolean(Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_product_confirmation_emailboolean(Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

enable_purchase_limitsboolean(Enable Purchase Limits)

If true, purchase limits are in place for this product

enable_purchasing_eligibilityboolean(Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

enable_special_pricesboolean(Enable Special Prices)

Whether to enable special pricing logic

enable_task_generationboolean(Enable Task Generation)

If set, tasks will be generated

foreign_currency_pricesArray of objects
grant_job_postingsboolean(Grant Job Postings)

Whether or not purchasers of this product should get job postings

grant_resume_accessboolean(Grant Resume Access)

If set, purchasers of this package will be able to access a resume bank

hide_from_portalboolean(Hide From Portal)

If set, this product should not be shown in the portal

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

The unique, string identifier of this miscellaneous product

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

is_activeboolean(Is Active)

Whether this product is active/used

job_posting_optionsobject(Job Posting Options)required
job_posting_options.​number_of_postingsnumber(float)(Number Of Postings)required

Number of postings to grant

member_pricenumber(double)(Member Price)

The price of the product for an active member

namestring(Name)required

The name of the miscellaneous product

notesstring(Notes)

Notes

portal_optionsobject(Portal Options)
pricenumber(double)(Price)required

The price of the product

product_confirmation_email_optionsobject(Product Confirmation Email Options)required
product_confirmation_email_options.​product_confirmation_email_idProduct Confirmation Email (string)(Product Confirmation Email)
One of:
string(Product Confirmation Email)
product_confirmation_email_options.​product_specific_emailProduct Specific Email (object)(Product Specific Email)
One of:
product_confirmation_email_options.​typestring(Type)
Enum"product specific""shared"
publish_to_portalboolean(Publish To Portal)

Whether or not this product should be available in the portal

purchase_limitsobject(Purchase Limits)required
purchase_limits.​error_messagestring(Error Message)

The error message to show

purchase_limits.​maximumnumber(float)(Maximum)required

The maximum

purchase_limits.​relative_time_windowRelative Time Window (object)(Relative Time Window)

the time window

One of:

the time window

purchase_limits.​time_periodstring(Time Period)required
Enum"all time""sliding time window"
purchase_limits.​typestring(Type)required
Value"per customer"
purchasing_eligibility_criteriaobject(Purchasing Eligibility Criteria)
resume_banksArray of objects
special_pricesArray of objectsnon-emptyrequired
special_prices[].​criteriaobject(Criteria)required
special_prices[].​enable_formulaboolean(Enable Formula)

if set, a formula is used to calculate the price. If the formula fails, the price is used

special_prices[].​formulaFormula (string)(Formula)

The formula evaluated using the expr-eval npm package

One of:

The formula evaluated using the expr-eval npm package

string(Formula)

The formula evaluated using the expr-eval npm package

special_prices[].​namestring(Name)
special_prices[].​pricenumber(float)(Price)required
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

tasks_to_generateArray of objects
typestring(Type)

The product type

Value"careers-packages"
curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/careers/careers-v1/packages/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow_customer_to_choose_installment_plan": true,
    "bulk_pricing_rules": [
      {
        "discount_amount": 0.1,
        "discount_type": "flat rate",
        "ending_range": 0,
        "starting_range": 0
      }
    ],
    "bundled_products": [
      {
        "member_price": 0.1,
        "price": 0.1,
        "product_id": "string",
        "product_type": "string",
        "quantity": 0,
        "type": "bundled product"
      }
    ],
    "bundled_products_inventory_handling": "bundle",
    "business_unit_id": "string",
    "cancellation_fee": 0.1,
    "commerce_entitlements_to_create": [
      {
        "expiration_date": null,
        "expiration_type": "none",
        "quantity": 0.1,
        "relative_expiration_date": {
          "number": null,
          "position": "after",
          "relative_to": "the beginning of the month",
          "unit_of_time": "days"
        },
        "type_id": "string"
      }
    ],
    "coupon_codes": [
      {
        "coupon_code_generation_process_id": "string",
        "coupon_code_type": "multi use",
        "coupon_id": "string",
        "coupon_type": "string",
        "expiration_date": null,
        "expiration_type": "none",
        "maximum_number_of_total_uses": 1,
        "maximum_number_of_uses_per_customer": 1,
        "quantity": 250,
        "relative_expiration_date": {
          "number": null,
          "position": "after",
          "relative_to": "the beginning of the month",
          "unit_of_time": "days"
        },
        "restrict_to_contact": true,
        "restrict_to_organization": true
      }
    ],
    "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": [
          {}
        ]
      }
    ],
    "custom_pricing_options": {
      "lambda_function_id": "string"
    },
    "description": "string",
    "display_order": 0.1,
    "document_entitlements_to_create": [
      {
        "expiration_date": null,
        "expiration_type": "none",
        "file_cabinet_id": "string",
        "item_id": "string",
        "library_path": "string",
        "relative_expiration_date": {
          "number": null,
          "position": "after",
          "relative_to": "the beginning of the month",
          "unit_of_time": "days"
        }
      }
    ],
    "enable_bulk_pricing": true,
    "enable_bundled_products": true,
    "enable_cancellation_fees": true,
    "enable_commerce_entitlement_creation": true,
    "enable_coupon_code_generation": true,
    "enable_custom_pricing": true,
    "enable_document_entitlement_creation": true,
    "enable_product_confirmation_email": true,
    "enable_purchase_limits": true,
    "enable_purchasing_eligibility": true,
    "enable_special_prices": true,
    "enable_task_generation": true,
    "foreign_currency_prices": [
      {
        "cancellation_fee": 0.1,
        "currency_code": "AED",
        "member_price": 0.1,
        "mode": "calculate price",
        "price": null,
        "restocking_fee": 0.1
      }
    ],
    "grant_job_postings": true,
    "grant_resume_access": true,
    "hide_from_portal": true,
    "id": "string",
    "installment_plan_options": [
      {
        "additional_cost": 0.1,
        "installment_plan_id": "string",
        "is_default": true
      }
    ],
    "is_active": true,
    "job_posting_options": {
      "number_of_postings": 0.1
    },
    "member_price": 0.1,
    "name": "string",
    "notes": "string",
    "portal_options": {
      "available_from": "2019-08-24T14:15:22Z",
      "available_until": "2019-08-24T14:15:22Z"
    },
    "price": 0.1,
    "product_confirmation_email_options": {
      "product_confirmation_email_id": null,
      "product_specific_email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "type": "product specific"
    },
    "publish_to_portal": true,
    "purchase_limits": {
      "error_message": "string",
      "maximum": 0.1,
      "relative_time_window": {
        "number": null,
        "position": "after",
        "relative_to": "the beginning of the month",
        "unit_of_time": "days"
      },
      "time_period": "all time",
      "type": "per customer"
    },
    "purchasing_eligibility_criteria": {},
    "resume_banks": [
      {
        "expiration_in_days": 0.1,
        "grant_access": true,
        "resume_bank_id": "string"
      }
    ],
    "special_prices": [
      {
        "criteria": {},
        "enable_formula": true,
        "formula": null,
        "name": "string",
        "price": 0.1
      }
    ],
    "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,
    "tasks_to_generate": [
      {
        "assignee_type": "assignment role",
        "assignment_role_id": null,
        "description": "string",
        "due_date_type": "none",
        "name": "string",
        "notify_assignees": true,
        "priority": "high",
        "queue_id": null,
        "relative_due_date": {
          "number": null,
          "position": "after",
          "relative_to": "the beginning of the month",
          "unit_of_time": "days"
        },
        "specific_due_date": null,
        "type_id": "string",
        "user_id": null
      }
    ],
    "type": "careers-packages"
  }'

Responses

The package was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bulk_pricing_rulesArray of objectsnon-emptyrequired
bulk_pricing_rules[].​discount_amountnumber(float)(Discount Amount)>= 0required

The percentage/flat rate

bulk_pricing_rules[].​discount_typestring(Discount Type)required

The type of discount rule

Enum"flat rate""percentage"
bulk_pricing_rules[].​ending_rangeinteger(Ending Range)>= 0

The ending range of the rule

bulk_pricing_rules[].​starting_rangeinteger(Starting Range)>= 0

The starting range of the rule

bundled_productsArray of objectsnon-emptyrequired
bundled_products[].​member_pricenumber(double)(Member Price)

The member price

bundled_products[].​pricenumber(double)(Price)

The price to bundle

bundled_products[].​product_idstring(Product)required

The product ID

bundled_products[].​product_typestring(Product Type)required

The product type

bundled_products[].​quantityinteger(Quantity)required

The quantity to bundle

bundled_products[].​typestring(Type)required
Enum"bundled product""inline bundled product"
bundled_products_inventory_handlingstring(Bundled Products Inventory Handling)

Whether to track inventory for the entire bundle, or for each product separately

Enum"bundle""each product"
business_unit_idstring(Business Unit)required

The business unit of the product

cancellation_feenumber(double)(Cancellation Fee)

Cancellation fees associated with this product

commerce_entitlements_to_createArray of objects
coupon_codesArray of objectsnon-emptyrequired
coupon_codes[].​coupon_code_generation_process_idstring(Coupon Code Generation Process)required

The process by which the coupons are generated

coupon_codes[].​coupon_code_typestring(Coupon Code Type)required
Enum"multi use""single use"
coupon_codes[].​coupon_idstring(Coupon)required
coupon_codes[].​coupon_typestring(Coupon Type)required
coupon_codes[].​expiration_dateExpiration Date (string)(date-time)(Expiration Date)
One of:
string(date-time)(Expiration Date)
coupon_codes[].​expiration_typestring(Expiration Type)
Enum"none""relative date""specific date"
coupon_codes[].​maximum_number_of_total_usesMaximum Number Of Total Uses (integer)(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

One of:

The maximum number of total uses

>= 1
integer(Maximum Number Of Total Uses)>= 1

The maximum number of total uses

Value1
coupon_codes[].​maximum_number_of_uses_per_customerMaximum Number Of Uses Per Customer (integer)(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

One of:

The maximum number of total uses for a given customer

>= 1
integer(Maximum Number Of Uses Per Customer)>= 1

The maximum number of total uses for a given customer

Value1
coupon_codes[].​quantityinteger(Quantity)<= 250required

The number of coupons to generate

coupon_codes[].​relative_expiration_dateRelative Expiration Date (object)(Relative Expiration Date)

Expiration date relative to purchase

One of:

Expiration date relative to purchase

coupon_codes[].​restrict_to_contactboolean(Restrict To Contact)

If true, the code generated is restricted to the contact who made the purchase

coupon_codes[].​restrict_to_organizationboolean(Restrict To Organization)

If true, the code generated is restricted to the organization made the purchase

custom_field_valuesArray of objects(Custom Field Values)
custom_pricing_optionsobject(Custom Pricing Options)required
custom_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

descriptionstring(Description)

Product description to be displayed on the portal

display_ordernumber(float)(Display Order)

The product display order

document_entitlements_to_createArray of objects
enable_bulk_pricingboolean(Enable Bulk Pricing)

Whether or not bulk pricing is enabled

enable_bundled_productsboolean(Enable Bundled Products)

Whether to enable bundled products

enable_cancellation_feesboolean(Enable Cancellation Fees)

Whether or not cancellation fees are applicable

enable_commerce_entitlement_creationboolean(Enable Commerce Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_coupon_code_generationboolean(Enable Coupon Code Generation)

If true, purchasing this product will generate coupons

enable_custom_pricingboolean(Enable Custom Pricing)

If set, the order engine will call out to a custom lambda function for custom/complex pricing

enable_document_entitlement_creationboolean(Enable Document Entitlement Creation)

If set, document entitlements will be created to access folders or documents

enable_product_confirmation_emailboolean(Enable Product Confirmation Email)

If enabled, a custom email goes out whenever this product is ordered

enable_purchase_limitsboolean(Enable Purchase Limits)

If true, purchase limits are in place for this product

enable_purchasing_eligibilityboolean(Enable Purchasing Eligibility)

If set, purchases of this merchandise are restricted

enable_special_pricesboolean(Enable Special Prices)

Whether to enable special pricing logic

enable_task_generationboolean(Enable Task Generation)

If set, tasks will be generated

foreign_currency_pricesArray of objects
grant_job_postingsboolean(Grant Job Postings)

Whether or not purchasers of this product should get job postings

grant_resume_accessboolean(Grant Resume Access)

If set, purchasers of this package will be able to access a resume bank

hide_from_portalboolean(Hide From Portal)

If set, this product should not be shown in the portal

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

The unique, string identifier of this miscellaneous product

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

is_activeboolean(Is Active)

Whether this product is active/used

job_posting_optionsobject(Job Posting Options)required
job_posting_options.​number_of_postingsnumber(float)(Number Of Postings)required

Number of postings to grant

member_pricenumber(double)(Member Price)

The price of the product for an active member

namestring(Name)required

The name of the miscellaneous product

notesstring(Notes)

Notes

portal_optionsobject(Portal Options)
pricenumber(double)(Price)required

The price of the product

product_confirmation_email_optionsobject(Product Confirmation Email Options)required
product_confirmation_email_options.​product_confirmation_email_idProduct Confirmation Email (string)(Product Confirmation Email)
One of:
string(Product Confirmation Email)
product_confirmation_email_options.​product_specific_emailProduct Specific Email (object)(Product Specific Email)
One of:
product_confirmation_email_options.​typestring(Type)
Enum"product specific""shared"
publish_to_portalboolean(Publish To Portal)

Whether or not this product should be available in the portal

purchase_limitsobject(Purchase Limits)required
purchase_limits.​error_messagestring(Error Message)

The error message to show

purchase_limits.​maximumnumber(float)(Maximum)required

The maximum

purchase_limits.​relative_time_windowRelative Time Window (object)(Relative Time Window)

the time window

One of:

the time window

purchase_limits.​time_periodstring(Time Period)required
Enum"all time""sliding time window"
purchase_limits.​typestring(Type)required
Value"per customer"
purchasing_eligibility_criteriaobject(Purchasing Eligibility Criteria)
resume_banksArray of objects
special_pricesArray of objectsnon-emptyrequired
special_prices[].​criteriaobject(Criteria)required
special_prices[].​enable_formulaboolean(Enable Formula)

if set, a formula is used to calculate the price. If the formula fails, the price is used

special_prices[].​formulaFormula (string)(Formula)

The formula evaluated using the expr-eval npm package

One of:

The formula evaluated using the expr-eval npm package

string(Formula)

The formula evaluated using the expr-eval npm package

special_prices[].​namestring(Name)
special_prices[].​pricenumber(float)(Price)required
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

tasks_to_generateArray of objects
typestring(Type)

The product type

Value"careers-packages"
Response
application/json
{ "allow_customer_to_choose_installment_plan": true, "bulk_pricing_rules": [ {} ], "bundled_products": [ {} ], "bundled_products_inventory_handling": "bundle", "business_unit_id": "string", "cancellation_fee": 0.1, "commerce_entitlements_to_create": [ {} ], "coupon_codes": [ {} ], "custom_field_values": [ {} ], "custom_pricing_options": { "lambda_function_id": "string" }, "description": "string", "display_order": 0.1, "document_entitlements_to_create": [ {} ], "enable_bulk_pricing": true, "enable_bundled_products": true, "enable_cancellation_fees": true, "enable_commerce_entitlement_creation": true, "enable_coupon_code_generation": true, "enable_custom_pricing": true, "enable_document_entitlement_creation": true, "enable_product_confirmation_email": true, "enable_purchase_limits": true, "enable_purchasing_eligibility": true, "enable_special_prices": true, "enable_task_generation": true, "foreign_currency_prices": [ {} ], "grant_job_postings": true, "grant_resume_access": true, "hide_from_portal": true, "id": "string", "installment_plan_options": [ {} ], "is_active": true, "job_posting_options": { "number_of_postings": 0.1 }, "member_price": 0.1, "name": "string", "notes": "string", "portal_options": { "available_from": "2019-08-24T14:15:22Z", "available_until": "2019-08-24T14:15:22Z" }, "price": 0.1, "product_confirmation_email_options": { "product_confirmation_email_id": null, "product_specific_email": {}, "type": "product specific" }, "publish_to_portal": true, "purchase_limits": { "error_message": "string", "maximum": 0.1, "relative_time_window": {}, "time_period": "all time", "type": "per customer" }, "purchasing_eligibility_criteria": {}, "resume_banks": [ {} ], "special_prices": [ {} ], "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, "tasks_to_generate": [ {} ], "type": "careers-packages" }

Query Definitions

Query Definitions

Operations

Resume Banks

Resume Banks

Operations

Resumes

Resumes

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations