Teams

Create a new team

Changed on

Create a new team organization

post/teams

Request

  • Base URL: https://api.session.services
  • URL: https://api.session.services/teams
  • Auth: API key in header x-tenant-id

Request body

namestring required

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

slugstring

URL-friendly slug for the team organization. If not provided, will be automatically generated from the name. Must be unique within tenant and between 3 and 30 characters

supportEmailstring email

Support email address for customer inquiries. Used as reply-to address in order confirmation emails

publicBaseUrlstring uri

Optional public website base URL for team-owned event and order links. When present, it overrides the tenant public base URL.

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. Defaults to PENDING if not specified.

Example request

{
  "publicBaseUrl": "https://sash.net.au",
  "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": []
    }
  }
}

Changes