v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

V1Employees

CreateEmployeeRole

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.

post/v1/me/roles

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