CHchrt
/orgs
/orgs/org_public_data

Set up org

Single onboarding entry point. Sets org_type in WorkOS JWT metadata (immutable once set) and idempotently creates org_private_data + org_public_data for the caller's organization. Required name and optional description and handle populate the public doc on first call; later updates go through PATCH /orgs/org_public_data/v1. Returns True on success (including idempotent retries), 400 on org_type conflict or handle collision. | (SetupOrgReq) -> (bool)

post/orgs/setup_org/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/orgs/setup_org/v1
  • Auth
    HTTP bearer

Request body

org_type'provider' | 'shipper' | 'vendor' required
namestring required
descriptionstring nullable
handlestring nullable

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

Response

Successful Response

boolean required

Changes

No recorded changes to this operation across all 20 revisions of this API.