Create Employee

post

https://api.branchapp.com/v1/organizations/{orgId}/employees/{employeeId}

Create a new employee. Updates if the employee already exists.

Path Params

orgId

int32

required

Organization ID

employeeId

string

required

Employee ID

Body Params

first_name

string

required

length ≥ 1

First name of employee. Numbers not allowed

last_name

string

required

length ≥ 1

Last name of employee. Numbers not allowed

phone_number

string

Phone number of employee. Required for Branch Direct

email_address

string

Email address of employee. Required for Branch Direct

type

string

enum

The employee's wage type

Allowed:

pay_rate

int32

≥ 0

Rate of pay, in cents, used in conjunction with type. The following should be defined as follows: If type = salary, then should be the annual salary of the employee If type = hourly, then should be the hourly rate the employee earns

business_name

string

A cosmetic descriptor of the employee's workplace

group_name

string

An additional layer of categorization within an organization allowing for more granular customized settings

ein

string

9 digit employer identification number

password

string

Password of the employee

state

string

Valid U.S. 2-character state abbreviation.

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

400Bad Request. If a field provided is invalid, an error response will be returned with a message describing why.