Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
V1Employees

UpdateEmployeeRole

Modifies the details of an employee role.

put/v1/me/roles/{role_id}

Path parameters

role_idstring required

The ID of the role to modify.

Request body

created_atstring

The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created.

idstring

The role's unique ID, Can only be set by Square.

is_ownerboolean

If true, employees with this role have all permissions, regardless of the values indicated in permissions.

namestring required

The role's merchant-defined name.

permissionsstring[] required

The role's permissions.

updated_atstring

The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated.

Response

Success

created_atstring

The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created.

idstring

The role's unique ID, Can only be set by Square.

is_ownerboolean

If true, employees with this role have all permissions, regardless of the values indicated in permissions.

namestring required

The role's merchant-defined name.

permissionsstring[] required

The role's permissions.

updated_atstring

The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated.