---
title: "Create or update team member"
method: POST
path: "/api/v1/team-members"
tags: ["Team members"]
---

# Create or update team member

`POST /api/v1/team-members`

## Request

- Base URL: `https://api.simplesat.io`
- URL: `https://api.simplesat.io/api/v1/team-members`
- Auth: API key in header `X-Simplesat-Token`

Create or update a team member.

If the team member with the specified email address already exists, the existing team member will be updated.

Updating the `custom_attributes` field will overwrite any existing custom attributes.

Required scopes: `write team members`

## Request body

- object
  - `external_id` string
  - `name` string
  - `email` string
  - `custom_attributes` object

## Response `201`

Successful response

- object
  - `id` integer
  - `external_id` string
  - `name` string
  - `email` string
  - `custom_attributes` object
  - `groups` TeamMemberGroup[]: The team member's groups.
    - `token` string: Unique identifier for the team member group, defined by Simplesat.
    - `name` string: The name of the team member group.

---

[API](https://skmtc.dev/simplesat/apis/simplesat-api-v1.md) · [All operations](https://skmtc.dev/simplesat/apis/simplesat-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/simplesat/apis/simplesat-api-v1/revisions/1c245425416b?raw)