POST
/
v1
/
entities
/
{id}
/
formation
/
start
Start formation
curl --request POST \
  --url https://api.orgs.sh/v1/entities/{id}/formation/start \
  --header 'Authorization: Bearer <token>'
{
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "Filing",
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token>. The token can be a legacy Orgs API key or a platform-minted JWT.

Path Parameters

id
string<uuid>
required

Entity UUID.

Response

Formation state after start request.

entity_id
string<uuid>
required
state
string
required
Example:

"Filing"

message
string
required