POST /v1/me/roles
Creates an employee role you can then assign to employees.
Square accounts can include any number of roles that can be assigned to employees. These roles define the actions and permissions granted to an employee with that role. For example, an employee with a "Shift Manager" role might be able to issue refunds in Square Point of Sale, whereas an employee with a "Clerk" role might not.
Roles are assigned with the V1UpdateEmployee endpoint. An employee can have only one role at a time.
If an employee has no role, they have none of the permissions associated with roles. All employees can accept payments with Square Point of Sale.
Servers
- https://connect.squareup.com
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 role's unique ID, Can only be set by Square. |
name |
String | Yes |
The role's merchant-defined name. |
is_owner |
Boolean | No |
If true, employees with this role have all permissions, regardless of the values indicated in permissions. |
permissions[] |
Array | Yes |
The role's permissions. |
created_at |
String | No |
The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created. |
updated_at |
String | No |
The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated. |
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.