Create an organization

$ straddle embed:organizations create

POST/v1/organizations

Creates a new organization related to your Straddle integration. Organizations can be used to group related accounts and manage permissions across multiple users.

ParametersExpand Collapse

--name: string

Body param: The name of the organization.

--external-id: optional string

Body param: Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems.

--metadata: optional map[string]

Body param: Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format.

--correlation-id: optional string

Header param: Optional client generated identifier to trace and debug a series of requests.

--idempotency-key: optional string

Header param: Optional client generated value to use for idempotent requests.

--request-id: optional string

Header param: Optional client generated identifier to trace and debug a request.

ReturnsExpand Collapse

organizationV1: object { data, meta, response_type }

data: object { id, created_at, name, 3 more }

id: string

Straddle's unique identifier for the organization.

created_at: string

Timestamp of when the organization was created.

name: string

The name of the organization.

updated_at: string

Timestamp of the most recent update to the organization.

external_id: optional string

Unique identifier for the organization in your database, used for cross-referencing between Straddle and your systems.

metadata: optional map[string]

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the organization in a structured format.

meta: object { api_request_id, api_request_timestamp }

Metadata about the API request, including an identifier and timestamp.

api_request_id: string

Unique identifier for this API request, useful for troubleshooting.

api_request_timestamp: string

Timestamp for this API request, useful for troubleshooting.

response_type: "object" or "array" or "error" or "none"

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

"object"

"array"

"error"

"none"

Create an organization

straddle embed:organizations create \
  --api-key 'My API Key' \
  --name name

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "external_id": "external_id",
    "metadata": {
      "foo": "string"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}

Returns Examples

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "external_id": "external_id",
    "metadata": {
      "foo": "string"
    }
  },
  "meta": {
    "api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "api_request_timestamp": "2019-12-27T18:11:19.117Z"
  },
  "response_type": "object"
}