Create an organization
Creates an organization with the person as its owner.
Its slug is chosen from the name. An app limited to reading cannot create one.
Guide: Create a team and a project
AuthorizationBearer <token>
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
name*string
The organization's name; its slug is derived from it.
Length
1 <= lengthExamples
curl -X POST "https://api.voidhash.com/api/v1/organizations" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Acme" }'{ "id": "org_w5xk2e7q0lzv3n8b1c4d6f9g", "name": "Acme", "slug": "acme", "logoUrl": null}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Missing key\n at [\"name\"]" }}{ "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": "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
Errors
This operation adds no error codes of its own. It can 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.