org

Update an existing org

patch/v1/org/{orgId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

customerIdstring

customer for billing processing

namestring

name of organization

slugstring

unique slug of organization

type'PRIVATE' | 'PUBLIC' | 'EDU' | 'GOV' | 'NONPROFIT' | 'DEMO' | 'TEST' | 'PORTFOLIO'

type of organization

industrystring

industry

estEmployeesinteger

approximate number of employees

estRevenueinteger

approximate amount of revenue

foundedYearstring

year of founding

phonestring

company phone number in E.164 format

emailstring

primary contact email

urlstring uri

website URL

status'ACTIVE' | 'INACTIVE' | 'DISABLED'

current status of organization

imagePathstring

path to full-sized profile image in storage

currenciesstring[]

types of currencies in use, with the first currency the primary currency

localesstring[]

locales supported within the org based on user selection, with the first locale the primary locale (e.g., en_US, en_GB, fr_FR, fr_CA)

dataResidency'US' | 'EU'

data residency of the org - the db cluster where this org's data resides

stockstring

stock symbol

timezonestring

timezone in use

appTimesstring[]

approximate times of day in the org timezone for daily app syncs to run (if unset, syncs will run 2am-8am US Eastern Time)

fiscalStartinteger

number of months into the calendar year that the fiscal year starts (1 = February, 2 = March)

portfolioParentOrgIdstring

portfolio parent org ID

startDatestring date

start date of history

onboardingboolean

current onboarding status of an organization, allowing clearing of org

selfServeImportingboolean

completion status of initial import for orgs signed up via self serve

headCountinteger

number of total headcount currently in the org

Response

org updated

Changes

No recorded changes to this operation across all 20 revisions of this API.