---
title: "Update a Team"
method: PATCH
path: "/teams/{subdomain}/"
tags: ["teams"]
---

# Update a Team

`PATCH /teams/{subdomain}/`

Required fields are **name** and **subdomain** where the subdomain is globally unique.
Use **POST** to create a Team.
To update a field on a Team use **PATCH**.

To use the API on behalf of a particular team change the endpoint to:
*https://**{{ subdomain }}**.signrequest.com/api/v1/...*

To invite new team members you can use **POST**
{"email":"**email-of-member-to-invite@example.com**","is_admin":false,"is_owner":false} to:
*https://signrequest.com/api/v1/teams/**{{ subdomain }}**/invite_member/*

## Request body

- Team
  - `name` string, required
  - `subdomain` string, slug, required
  - `url` string, uri
  - `logo` string, uri, nullable
  - `phone` string
  - `primary_color` string
  - `events_callback_url` string, uri, nullable
  - `documents_as_attachments` boolean, nullable
  - `members` InlineTeamMember[]
    - `uuid` string
    - `url` string, uri
    - `user` User
      - `email` string, email, required
      - `first_name` string
      - `last_name` string
      - `display_name` string
    - `is_admin` boolean
    - `is_active` boolean
    - `is_owner` boolean
  - `delete_after` string, date-time, nullable — When filled this team will be deleted after this date
  - `sandbox` boolean — Indicates whether team is in Sandbox mode

## Response `200`

OK

- Team
  - `name` string, required
  - `subdomain` string, slug, required
  - `url` string, uri
  - `logo` string, uri, nullable
  - `phone` string
  - `primary_color` string
  - `events_callback_url` string, uri, nullable
  - `documents_as_attachments` boolean, nullable
  - `members` InlineTeamMember[]
    - `uuid` string
    - `url` string, uri
    - `user` User
      - `email` string, email, required
      - `first_name` string
      - `last_name` string
      - `display_name` string
    - `is_admin` boolean
    - `is_active` boolean
    - `is_owner` boolean
  - `delete_after` string, date-time, nullable — When filled this team will be deleted after this date
  - `sandbox` boolean — Indicates whether team is in Sandbox mode

---

[API](https://skmtc.net/signrequest/apis/signrequest-api.md) · [All operations](https://skmtc.net/signrequest/apis/signrequest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/signrequest/signrequest-api/revisions/6bbe20e3fe44/schema)