<- Team API

Team API

All versions ->

Create team member

POST

 /v2/team-members

Creates a single TeamMember object.

The TeamMember object is returned on successful creates. You must provide the following values in your request to this endpoint:

  • given_name
  • family_name

Learn about Troubleshooting the Team API.

Permissions:EMPLOYEES_WRITE

Guide

Set up a new team member

Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

A unique string that identifies this CreateTeamMember request. Keys can be any valid string, but must be unique for every request. For more information, see Idempotency.

The minimum length is 1 and the maximum length is 45.

Link to section

team_member

Required The data used to create the TeamMember object. If you include wage_setting, you must provide job_id for each job assignment. To get job IDs, call ListJobs.

Link to section

Response fields

Link to section

team_member

The successfully created TeamMember object.

Link to section

errors

The errors that occurred during the request.

Error descriptions