Learn how to troubleshoot errors with the Team API.
Team API

Troubleshoot 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.

  • Updating email_address use the email address of a different team member. A given email address can only be registered to a single team member.

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:

  • Invalid JobAssignment objects are included in job_assignments. Common invalid job assignments include:

  • There is no active Team Plus subscription with the Square account and job_assignments in the request body contains more than one job assignment.

    Subscribe to activate a Team Plus subscription to be able to add multiple wages for a team member in the Seller Dashboard:

    1. Open the Team page in the Seller Dashboard.

    2. Choose the team member who you want to have multiple wages.

      A graphic showing where to add team member permissions in the Seller Dashboard Team management application.

    3. In the team member window, choose ... to open a menu of more edit options.

    4. Choose Edit Compensation.

      A graphic showing where to set a team member job title in the Seller Dashboard Team management application.

    5. Choose Sign up for Team Plus to add another wage.

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.

If you need more assistance, contact Developer Support or ask for help in the Developer Forums.