Skip to content
straddle API Docs
Get started
API Reference
Embed
Organizations

Create an organization

OrganizationV1 Embed.Organizations.Create(OrganizationCreateParamsparameters, CancellationTokencancellationToken = default)
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
OrganizationCreateParams parameters
required string name

Body param: The name of the organization.

string? externalID

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

IReadOnlyDictionary<string, string>? metadata

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

string correlationID

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

string idempotencyKey

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

maxLength40
minLength10
string requestID

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

ReturnsExpand Collapse
class OrganizationV1:
required Data Data
required string ID

Straddle's unique identifier for the organization.

formatuuid
required DateTimeOffset CreatedAt

Timestamp of when the organization was created.

formatdate-time
required string Name

The name of the organization.

required DateTimeOffset UpdatedAt

Timestamp of the most recent update to the organization.

formatdate-time
string? ExternalID

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

IReadOnlyDictionary<string, string>? Metadata

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

required ResponseMetadata Meta

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

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid
required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time
required ResponseType ResponseType

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.
One of the following:
"object"Object
"array"Array
"error"Error
"none"None

Create an organization

OrganizationCreateParams parameters = new() { Name = "name" };

var organizationV1 = await client.Embed.Organizations.Create(parameters);

Console.WriteLine(organizationV1);
{
  "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"
}