You are viewing an old version of the API
Create employee role
V1

Note We recommend using the Square API (V2) for all new development when possible.

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.

Required permissions EMPLOYEES_WRITE

Request Body

Name Description
id
string

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

name
string

Required

The role's merchant-defined name.

permissions
string [ ]

Required

The role's permissions.

created_at
string

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

is_owner
boolean

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

updated_at
string

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

Response Fields

Name Description
id
string

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

name
string

Required

The role's merchant-defined name.

permissions
string [ ]

Required

The role's permissions.

created_at
string

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

is_owner
boolean

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

updated_at
string

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

Examples

You are viewing an old version of the API
POST /v1/me/roles
cURL
  • cURL
curl https://connect.squareup.com/v1/me/roles \
  -X POST \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?