Team API

Troubleshooting the Team API

This topic helps you troubleshoot errors with Team API operations by providing the error conditions for each error code you might encounter.

The Team API uses the standard set of Square error codes to communicate API operation errors. This topic gives details about the request state that returns errors.

Create a team member
Permalink Get a link to this section

The Square error response says that the request is a BAD_REQUEST.

Cause
Permalink Get a link to this section

Any of the following error conditions might apply:

Update a team member
Permalink Get a link to this section

The Square error response says that the request is a BAD_REQUEST.

Cause
Permalink Get a link to this section

Any of the following error conditions might apply:

  • The request body is clearing required fields.

  • The request body phone_number and email_address values are not in a valid format.

  • Updating email_address when a team member has already linked their Square account. This is because a team member's Square account email cannot be changed.

Retrieve a team member
Permalink Get a link to this section

The Square error response says that the request is a BAD_REQUEST.

Cause
Permalink Get a link to this section

The team member ID is not found.

Create or update a wage setting
Permalink Get a link to this section

The Square error response says that the request is a BAD_REQUEST or an UNPROCESSABLE_ENTITY.

BAD_REQUEST
Permalink Get a link to this section

Any of the following error conditions might apply:

UNPROCESSABLE_ENTITY
Permalink Get a link to this section

Any of the following error conditions might apply:

Bulk create team members
Permalink Get a link to this section

An attempt to create TeamMember objects can result in a BAD_REQUEST error when:

Bulk update team members
Permalink Get a link to this section

An attempt to update TeamMember objects can result in a BAD_REQUEST error when:

  • Clearing required fields.

  • The phone_number and email_address values are not in a valid format.

  • Updating email_address when a team member has already linked their Square account. This is because a team member's Square account email cannot be changed.