Update an existing organization
Updates an existing organization’s basic details, contact information, and addresses. Only provided fields will be updated (partial update). Addresses can be added, modified, or removed.
PATCH
/api/v1/{team_slug}/{app_slug}/organisations/{org_id}deprecatedAuthorization
AuthorizationAPI key · headerrequiredBearer token (format: "Bearer {token}")
Path parameters
app_slugstringrequiredApp slug
team_slugstringrequiredTeam slug
org_idstringrequiredOrganization ID
Request body
requiredapplication/jsonUpdated organization details
addressesinternal_pkg_webserver_v1.InputOrganisationAddress[]Show propertiesHide properties
Array of
internal_pkg_webserver_v1.InputOrganisationAddresscitystringrequiredco_addressstringcompany_namestringrequiredcountrystringrequiredhouse_numberstringidstringis_defaultbooleannamestringphonestringpostal_codestringrequiredshipping_typestringrequiredAllowed:
billingshippingstate_provincestringstreet_addressstringrequiredcommentstringcontact_namestringcredit_checkbooleancustom_fieldsgithub_com_enadhq_nabbit_internal_pkg_database.CustomFieldscustomer_group_idsstring[]emailstringexternal_refstringinvoice_emailstringnamestringorganisation_numberstringparent_idstringphonestringstatusstringAllowed:
activependinginactivetax_id_vat_numberstringResponses
200
Updated organization
datainternal_pkg_webserver_v1.OrganisationWithUsersAndAddressesrequiredShow propertiesHide properties
app_idstringattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Attributecreated_atstringdescriptionstring | nullfilterableboolean | nullidstringkeystringnamestring | nulltemplate_keystringtemplate_namestringtranslatableboolean | nulltranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.AttributeTranslationsShow propertiesHide properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Translationidstringlocalestringvaluestringnamegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]updated_atstring | nullvaluesobject | nullbilling_addressinternal_pkg_webserver_v1.OrganisationAddress[] | nullShow propertiesHide properties
Array of
internal_pkg_webserver_v1.OrganisationAddresscitystringco_addressstringcompany_idstringcompany_namestringcountrystringcreated_atstringhouse_numberstringidstringis_defaultbooleannamestringphonestringpostal_codestringstate_provincestringstreet_addressstringupdated_atstring | nullcommentstringcontact_namestringcreated_atstringcredit_checkbooleancustom_fieldsgithub_com_enadhq_nabbit_internal_pkg_database.CustomFields | nullShow propertiesHide properties
Any of:
github_com_enadhq_nabbit_internal_pkg_database.CustomFields
objectnull
nullcustomer_groupsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CustomerGroupRef[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.CustomerGroupRefidstringnamestringslugstringemailstringexternal_refstringidstringinvoice_emailstringnamestringorganisation_numberstring | nullparent_idstringphonestringshipping_addressinternal_pkg_webserver_v1.OrganisationAddress[] | nullShow propertiesHide properties
Array of
internal_pkg_webserver_v1.OrganisationAddresscitystringco_addressstringcompany_idstringcompany_namestringcountrystringcreated_atstringhouse_numberstringidstringis_defaultbooleannamestringphonestringpostal_codestringstate_provincestringstreet_addressstringupdated_atstring | nullstatusstringtagsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Tag[]Show propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Tagattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullcreated_atstringfilterablebooleanidstringkeystringmarketsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Marketactivebooleancountry_codesstring[] | nullcreated_atstringcurrency_codestringidstringlocalestringnamestringslugstringupdated_atstring | nullnamestringschedulesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Job[] | nullShow propertiesHide properties
Array of
github_com_enadhq_nabbit_internal_pkg_webserver_models.Jobadd_category_namesstring[]add_collection_namesstring[]add_tag_namesstring[]execute_atstringDate when the job should run
finished_atstring | nullIf a job is finished will this timestamp be filled
group_idstringidstringitem_idstringitem_namestringitem_typestringremove_category_namesstring[]remove_collection_namesstring[]remove_tag_namesstring[]to_amount_cents_with_taxinteger | nullto_market_idstringto_market_statusstringto_on_saleboolean | nullto_sale_amount_cents_with_taxinteger | nullto_start_sale_timestampstringto_statusstring | nullto_stop_sale_timestampstringto_store_group_idstringstatusstringtranslationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.TagTranslationsShow propertiesHide properties
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]updated_atstring | nulltax_id_vat_numberstringupdated_atstring | nullusersinternal_pkg_webserver_v1.OrganisationUser[] | nullShow propertiesHide properties
Array of
internal_pkg_webserver_v1.OrganisationUserattributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | nullcreated_atstringcustom_role_idstringcustom_role_namestringcustom_role_slugstringemailstringemail_verifiedbooleanidstringlanguagestringlevelstringmarketstringnamestring | nullphone_numberstring | nullstore_groupstringsurnamestring | nullupdated_atstring | nulldetailsstring[]Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanrequired400
Invalid request (e.g. bad payload, validation error, organization number already exists)
detailsstring[]messagestringsuccessbooleanrequired401
Unauthorized access
detailsstring[]messagestringsuccessbooleanrequired404
Organization not found
detailsstring[]messagestringsuccessbooleanrequired500
Internal server error
detailsstring[]messagestringsuccessbooleanrequired