Update organization settings
Changes the settings in the body; settings left out keep their values.
Returns every setting. A reporting currency applies to every report from then on, past ranges included. A preferred language applies to a bot's next message. Nothing changes when a setting fails. Needs permission to update the organization.
Guide: Create a team and a project
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The organization's id, org_....
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The BCP 47 tag of a language Voidhash offers, such as cs or pt-BR. It applies to a bot's next message.
An uppercase ISO 4217 code Voidhash keeps daily exchange rates for since 2010, such as EUR. It applies to every report from then on, past ranges included.
Examples
curl -X PATCH "https://api.voidhash.com/api/v1/organizations/org_w5xk2e7q0lzv3n8b1c4d6f9g/settings" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "reportingCurrency": "EUR" }'{ "preferredLanguage": null, "reportingCurrency": "EUR"}{ "error": { "type": "invalid_request", "code": "unsupported_currency", "message": "XAU cannot be a reporting currency; choose one of AED, AUD, BRL, CAD, CHF, CNY, CZK, DKK, EUR, GBP, HKD, HUF, ILS, INR, ISK, JPY, KRW, MXN, MYR, NOK, NZD, PHP, PLN, RON, SAR, SEK, SGD, THB, TRY, TWD, USD, ZAR.", "param": "reportingCurrency" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "organization_not_found", "message": "There is no organization org_w5xk2e7q0lzv3n8b1c4d6f9g, or this credential cannot use it.", "param": "organizationId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | unsupported_currency | For a currency without exchange rates back to 2010. |
| 400 | invalid_request | unsupported_language | For a language Voidhash doesn't offer. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Organizations
Something wrong or missing on this page? Tell us by email or on Discord.