PUT /v1/me/roles/{role_id}
Modifies the details of an employee role.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
role_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 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.