Add/Create an Enterprise

post

https://prod1.serveture.com/public-api/add_enterprise/

Creates an enterprise in the WorkN platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

The name for the enterprise.

return_email

string

The return email that will be used for enterprise specific emails. Note: This must always be sent with a serveture.com domain unless an alternative has been agreed upon with WorkN beforehand. If this is sent with any other domain, all enterprise specific emails will not be sent out.

contact_email

string

The email address that enterprise-level communication will be sent to, including billing files if the enterprise is subscribed to those.

bcc_email

string

The blind carbon copy (BCC) email address designated to receive copies of key enterprise-level emails.

support_email

string

The email address that web users will use for support communication.

support_phone

string

The phone number that web users will use for support communication.

time_zone

string

required

The time zone used for this enterprise for communication/display. Valid time zone strings are located in Appendix D.

zero_staff_pricing

boolean

Defaults to false

An indication of whether the staff are priced at a 0 rate or not. Note: By default, the value is set to False, meaning staff are not billed at 0 rates.

workn_checkin

int32

An indication of whether the WorkN check-in/check-out will be included on the mobile apps. The values are as follows: 1 indicates that the check-in/check-out for WorkN is ON; 0 indicates that the check-in/check-out for WorkN is OFF; -1 indicates that the check-in/check-out follows the Marketplace setting. Default value is -1.

peoplenet_checkin

int32

An indication of whether the PeopleNet check-in/check-out will be included on the mobile apps. The values are as follows: 1 indicates that the check-in/check-out for PeopleNet is ON; 0 indicates that the check-in/check-out for PeopleNet is OFF; -1 indicates that the check-in/check-out follows the Marketplace setting. The default value is -1. Note: PeopleNet check-in being enabled will always force WorkN check-in to be enabled, regardless of what the workn_checkin value is.

ext_customer_id

string

The external customer identifier that can be used to reference the customer.

branch_id

string

An internal WorkN identifier assigned to a branch. If specified, it will be used to link the enterprise to the branch.

ext_branch_id

string

The caller's internally used identifier for a customer branch (branch to WorkN). Note: If supplied, this value will be used instead of the branch_id to lookup in WorkN's system and determine the proper branch to link this enterprise to. This value must not exceed 50 characters.

Headers

Authorization

string

required

Defaults to Token <place token here>

The authorization token returned from the Log In endpoint.

Responses

200200

2XX2XX