• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Update employee
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Required permissions: EMPLOYEES_WRITE

Path Parameters

Name Description
employee_id
string

Required

The ID of the role to modify.

Request Body

Name Description
id
string

The employee's unique ID.

first_name
string

Required

The employee's first name.

last_name
string

Required

The employee's last name.

role_ids
string [ ]

The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee.

authorized_location_ids
string [ ]

The IDs of the locations the employee is allowed to clock in at.

email
string

The employee's email address.

status
string

CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard.

external_id
string

An ID the merchant can set to associate the employee with an entity in another system.

created_at
string

The time when the employee entity was created, in ISO 8601 format.

updated_at
string

The time when the employee entity was most recently updated, in ISO 8601 format.

Response Fields

Name Description
id
string

The employee's unique ID.

first_name
string

Required

The employee's first name.

last_name
string

Required

The employee's last name.

role_ids
string [ ]

The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee.

authorized_location_ids
string [ ]

The IDs of the locations the employee is allowed to clock in at.

email
string

The employee's email address.

status
string

CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard.

external_id
string

An ID the merchant can set to associate the employee with an entity in another system.

created_at
string

The time when the employee entity was created, in ISO 8601 format.

updated_at
string

The time when the employee entity was most recently updated, in ISO 8601 format.

Examples

You are viewing an old version of the API
PUT /v1/me/employees/{employee_id}
cURL
  • cURL
curl https://connect.squareup.com/v1/me/employees/employee_id0 \
  -X PUT \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?