Teams

Update a team

Update a team for the authenticated workspace. If there’s no change, returns it as it is.

patch/teams/{id}

Request

  • Base URL
    https://api.midday.ai
  • URL
    https://api.midday.ai/teams/{id}
  • Auth
    • OAuth 2
      Authorization code: https://app.midday.ai/oauth/authorize
      Token URL: https://api.midday.ai/oauth/token
    • or HTTP bearer

Path parameters

idstring uuid required

Unique identifier of the team

Example:123e4567-e89b-12d3-a456-426614174000

Request body

namestring

Name of the team or organization. Must be between 2 and 32 characters

emailstring email

Primary contact email address for the team

logoUrlstring uri

URL to the team's logo image. Must be hosted on midday.ai domain

baseCurrencystring

Base currency for the team in ISO 4217 format (3-letter currency code)

countryCodestring

Country code for the team

fiscalYearStartMonthinteger nullable

Month when the fiscal year starts (1-12). Null for trailing 12 months. Defaults based on country if not specified.

companyType'freelancer' | 'solo_founder' | 'small_team' | 'startup' | 'agency' | 'ecommerce' | 'creator' | 'non_profit' | 'accountant' | 'exploring'

Type of company or team

heardAbout'twitter' | 'youtube' | 'friend' | 'google' | 'blog' | 'podcast' | 'github' | 'other'

How the user heard about the product

Example request

{
  "name": "Acme Corporation",
  "email": "team@acme.com",
  "logoUrl": "https://cdn.midday.ai/logos/acme-corp.png",
  "baseCurrency": "USD",
  "countryCode": "US",
  "fiscalYearStartMonth": 4,
  "companyType": "solo_founder",
  "heardAbout": "twitter"
}

Response

Team updated

idstring uuid required

Unique identifier of the team

namestring required

Name of the team or organization

logoUrlstring uri nullable required

URL to the team's logo image

plan'trial' | 'starter' | 'pro' required

Current subscription plan of the team

emailstring email nullable

Primary contact email address for the team

baseCurrencystring nullable

Base currency for the team in ISO 4217 format (3-letter currency code)

countryCodestring nullable

Country code for the team in ISO 3166-1 alpha-2 format

fiscalYearStartMonthinteger nullable

Month when the fiscal year starts (1-12). Null for trailing 12 months.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "logoUrl": "https://cdn.midday.ai/logos/acme-corp.png",
  "plan": "pro",
  "email": "team@acme.com",
  "baseCurrency": "USD",
  "countryCode": "US",
  "fiscalYearStartMonth": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.