Organization

Create organization

Changed on

Create a new organization.

post/v1/organizations

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization)

Request body

slugstring required

Globally unique canonical kebab-case slug. Reserved values are join and new. Must not parse as an xid.

namestring required

Name of the organization.

emailstring email required

Email address of the organization.

logostring uri

Logo of the organization.

websitestring uri

Work title of the user.

Example request

{
  "slug": "acme",
  "name": "ACME Inc.",
  "email": "info@example.com",
  "logo": "https://example.com/static/logo.png",
  "website": "https://example.com"
}

Response

Example response

idstring required

ID of the newly created resource.

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 836ecb425096Revision changes
    • breaking

      added the new required request property

    • info

      added the non-success response with the status