Organizations are the top-level entities in Prospero. All other entities in Prospero are associated with an Organization.
Update an Organization
Updates the specified Organization by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change an Organization's id.
path Parameters
orgIdstring · uuid · requiredThe id of the
Organization.
Request Body
idstring · uuid · readOnlyThe globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnlyAn ISO 8601-compliant datetime string, formatted
YYYY-MM-DDThh:mm:ssZ.lastUpdatedAtstring · date-time · readOnlyAn ISO 8601-compliant datetime string, formatted
YYYY-MM-DDThh:mm:ssZ.namestringDisplayed in the admin app and email notifications.
namespacestringA globally unique namespace across all Prospero
Organizations. Used to create routes forViewlinks andPortalURLs.logoIdstring · uuidThe UUID of an image stored in Cloudflare Images. Used in the center of generated QR codes.
userIdsstring[] · readOnlyThe ids of the
Usersthat are members of thisOrganization.orgInvitationIdsstring[] · readOnlyThe ids of the
OrganizationInvitationsthat are pending for thisOrganization.localeinteger · enumThe preferred language and dialect of the
Organization. Used to generate localizedOffersandInvoices.1 =
UNITED_STATES_ENGLISH, 2 =NETHERLANDS_DUTCH, 3 =NETHERLANDS_ENGLISH, 4 =UNITED_KINGDOM_ENGLISHEnum values:1234displayCurrencyinteger · enumUsed as the default currency when defining prices for entities and generating
OffersandInvoices.0 =
USD, 1 =EUR, 2 =GBPEnum values:012billingAdminSettingsobjectSettings used when generating
OffersandInvoices.archivalSettingsobjectSettings for automatic archiving of entities.
Responses
The updated Organization.
organizationobject