Create a client org

POST

/v1/workspaces/{workspaceId}/sharees

curl --request POST \
  --url https://shareout.site/v1/workspaces/example/sharees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "type": "client" }'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

Request Body^required

Media typeapplication/json

object

name

required

string

type

string

default: client

Responses

201

Created

Media typeapplication/json

object

id

string

name

string

type

Client, supplier, partner, investor, or any label.

string

member_count

integer

branding

object

logo

string

color

string

Example^generated

{
  "id": "example",
  "name": "example",
  "type": "example",
  "member_count": 1,
  "branding": {
    "logo": "example",
    "color": "example"
  }
}

403

Access denied

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}