Organizations

Update the current organization

Updates the current organization's profile, regional defaults, and reply-to default and returns the saved organization. metadata is merged into the stored value; every other field is replaced.

patch/v1/organizations/current

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/organizations/current
  • Auth: API key in header x-api-key

Request body

namestring nullable
slugstring nullable
defaultRegionstring

An ISO 3166-1 alpha-2 region code, such as US or IN.

timezonestring
isActiveboolean nullable
metadataobject nullable
replyToDefaultstring[] nullable
emailFooterEnabledDefaultboolean nullable

Response

Organization

idstring required
billingAccountIdstring required
namestring required
slugstring required
defaultRegionstring required

An ISO 3166-1 alpha-2 region code, such as US or IN.

timezonestring required
planstring required
isActiveboolean required
createdAtstring required
updatedAtstring required
metadataobject nullable required
replyToDefaultstring[] nullable required
emailFooterEnabledDefaultboolean nullable required
messagesUsednumber required
messagesUsedThisMonthnumber required
emailUsednumber required
emailUsedThisMonthnumber required
contactsUsednumber required
conversationsUsednumber required
teamMembersUsednumber required
messagesResetAtstring nullable required

Changes

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