Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Teams

Update a team

Update an existing team by ID or slug

patch/teams/{key}

Path parameters

keystring required

Team key - either a unique ID (tem_xxx format) or URL-friendly slug

Example:tem_01jqpjksnsen9vprw95et60t2m

Request body

namestring

Display name of the team organization. Must be between 3 and 30 characters

slugstring

URL-friendly slug for the team organization. Must be unique within tenant and between 3 and 30 characters

supportEmailstring email nullable

Support email for customer inquiries. Pass null to clear, omit to leave unchanged.

publicBaseUrlstring uri nullable

Public website base URL for team-owned event and order links. Pass null to clear, omit to leave unchanged.

metadataobject

Flexible key-value metadata storage for custom configuration. Similar to Stripe's metadata API. Maximum 50 keys, key names up to 40 characters, values up to 500 characters.

approval'PENDING' | 'APPROVED' | 'REJECTED'

Approval status of the team. PENDING: awaiting review, APPROVED: can create promoters/venues/events, REJECTED: cannot operate

deletedAtstring date-time

Timestamp in ISO 8601 format when the team was soft deleted. Only present for deleted teams.

isAdminboolean

Whether this team is the admin team for the tenant

Example request

{
  "image": {
    "src": "https://assets.session.services/my-image.jpg",
    "alt": "My Image",
    "width": 1080,
    "height": 1080
  }
}

Response

OK

Example response

{
  "team": {
    "publicBaseUrl": "https://sash.net.au",
    "image": {
      "src": "https://assets.session.services/my-image.jpg",
      "alt": "My Image",
      "width": 1080,
      "height": 1080
    },
    "member": {
      "permissions": []
    }
  }
}