PUT /v1/me/employees/{employee_id}
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
employee_id |
String | Yes |
The ID of the role to modify. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
The employee's unique ID. |
external_id |
String | No |
An ID the merchant can set to associate the employee with an entity in another system. |
email |
String | No |
The employee's email address. |
last_name |
String | Yes |
The employee's last name. |
role_ids[] |
Array | No |
The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee. |
first_name |
String | Yes |
The employee's first name. |
authorized_location_ids[] |
Array | No |
The IDs of the locations the employee is allowed to clock in at. |
status |
String | No |
Whether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. |
created_at |
String | No |
The time when the employee entity was created, in ISO 8601 format. |
updated_at |
String | No |
The time when the employee entity was most recently updated, in ISO 8601 format. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.