<- Team API

Team API

All versions ->

Update wage setting

PUT

 /v2/team-members/{team_member_id}/wage-setting

Creates or updates a WageSetting object.

The object is created if a WageSetting with the specified team_member_id doesn't exist. Otherwise, it fully replaces the WageSetting object for the team member. The WageSetting is returned on a successful update. For more information, see Troubleshooting the Team API.

Square recommends using CreateTeamMember or UpdateTeamMember to manage the TeamMember.wage_setting field directly.

Permissions:EMPLOYEES_WRITE

Guide

Assign a job title and wage

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

team_member_id

string

Required

The ID of the team member for which to update the WageSetting object.

Link to section

Request body

Link to section

wage_setting

Required

The complete WageSetting object. For all job assignments, specify one of the following:

  • job_id (recommended) - If needed, call ListJobs to get a list of all jobs. Requires Square API version 2024-12-18 or later.
  • job_title - Use the exact, case-sensitive spelling of an existing title unless you want to create a new job. This value is ignored if job_id is also provided.
Link to section

Response fields

Link to section

wage_setting

The successfully updated WageSetting object.

Link to section

errors

The errors that occurred during the request.