Supported Formats

json

Errors

Code Description
422 Could not save the Customer

Params

Param name Description
token
required

Token obtained from /authenticate

Validations:

  • Must be a String

customer
required

Customer Info

Validations:

  • Must be a Hash

customer[name]
required

Customer Name

Validations:

  • Must be a String

customer[account_owner]
optional

Account Owner

Validations:

  • Must be a String

customer[account_manager]
optional

Account Manager

Validations:

  • Must be a String

customer[address]
optional

Address

Validations:

  • Must be a String

customer[city]
optional

City

Validations:

  • Must be a String

customer[state]
optional

State

Validations:

  • Must be a String

customer[zip]
optional

Zip

Validations:

  • Must be a String

customer[phone]
optional

Phone

Validations:

  • Must be a String

customer[contact_first_name]
optional

Contact First Name

Validations:

  • Must be a String

customer[contact_last_name]
optional

Contact Last Name

Validations:

  • Must be a String

customer[contact_email]
optional

Contact Email

Validations:

  • Must be a String

customer[billing_first_name]
optional

Billing First Name - must be between 1 and 50 characters in length

Validations:

  • Must be a String

customer[billing_last_name]
optional

Billing Last Name - must be between 1 and 50 characters in length

Validations:

  • Must be a String

customer[billing_email]
optional

Billing Email - must be between 1 and 255 characters in length

Validations:

  • Must be a String

customer[billing_phone]
optional

Billing Phone - must be between 1 and 50 characters in length

Validations:

  • Must be a String

customer[fee_percentage]
optional

Fee Percentage - must be between 0.0 and 1.0

Validations:

  • Must be a Float

customer[can_post_w2]
optional

True if this Customer can post w2 job requests. Default is False when not set

Validations:

  • Must be one of: true, false.

customer[can_post_1099]
optional

True if this Customer can post 1099 job request. Default is True when not set

Validations:

  • Must be one of: true, false.

customer[can_use_premier_features]
optional

True if this Customer can use premium features

Validations:

  • Must be one of: true, false.

customer[use_start_and_complete_pin]
optional

True if this Customer can use Start and Complete Pin. Default is False when left blank or not set

Validations:

  • Must be one of: true, false.

customer[strategic_pilot]
optional

True if this Customer is strategic pilot

Validations:

  • Must be one of: true, false.

customer[use_pending_state]
optional

True if this Customer can use Pending Workflow. Default is False when not set

Validations:

  • Must be one of: true, false.