POST
/
v1
/
organizations
curl --request POST \
  --url https://{environment}.straddle.io/v1/organizations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "metadata": {},
  "external_id": "<string>"
}'
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "external_id": "<string>",
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.

Headers

​
request-id
string

Optional client generated identifier to trace and debug a request.

​
correlation-id
string

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

Body

​
name
string
required

The name of the organization.

​
metadata
object | null

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

​
external_id
string | null

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

Response

201
text/plain
Created
​
meta
object
required
​
response_type
enum<string>
required

Indicates the type of data returned.

Available options:
object,
array,
error,
none
​
data
object
required

Was this page helpful?

Suggest editsRaise issue
Lookup funding detailsList organizations