Create an organization

embed.organizations.create() -> OrganizationV1

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: str

The name of the organization.

external_id: Optional[str]

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

metadata: Optional[Dict[str, Optional[str]]]

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

correlation_id: Optional[str]

idempotency_key: Optional[str]

request_id: Optional[str]

ReturnsExpand Collapse

class OrganizationV1: …

data: Data

id: str

Straddle's unique identifier for the organization.

formatuuid

created_at: datetime

Timestamp of when the organization was created.

formatdate-time

name: str

The name of the organization.

updated_at: datetime

Timestamp of the most recent update to the organization.

formatdate-time

external_id: Optional[str]

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

metadata: Optional[Dict[str, Optional[str]]]

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

meta: ResponseMetadata

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: Literal["object", "array", "error", "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.

Accepts one of the following:

"object"

"array"

"error"

"none"

Create an organization

from straddle import Straddle

client = Straddle(
    api_key="My API Key",
)
organization_v1 = client.embed.organizations.create(
    name="name",
)
print(organization_v1.data)

{
  "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"
}