Headers
Bearer token for authentication
Body
application/json
Response
Workspace created successfully
curl --request POST \
--url https://api.wellapp.ai/v1/workspaces \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"type": "workspace",
"attributes": {
"name": "Marketing Team Workspace",
"description": "Collaborative workspace for the marketing team to manage campaigns and content",
"avatar_color": "#FF5733",
"external_workspace_id": "mkt-workspace-001",
"auto_extract_enabled": false
},
"relationships": {
"owner": {
"data": {
"type": "people",
"id": "temp-id1"
}
}
},
"included": {
"owner": {
"data": {
"type": "people",
"id": "temp-id1",
"attributes": {
"first_name": "Sophie",
"last_name": "Martin"
}
}
}
}
}'
{
"data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {
"name": "<string>",
"desription": "<string>",
"external_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"avatar_color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"owner": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
},
"included": [
{
"type": "peoplex",
"id": "temp-people1",
"attributes": {
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"created_at": "<string>",
"updated_at": "<string>"
}
}
]
}
}
Create a new workspace record
curl --request POST \
--url https://api.wellapp.ai/v1/workspaces \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"type": "workspace",
"attributes": {
"name": "Marketing Team Workspace",
"description": "Collaborative workspace for the marketing team to manage campaigns and content",
"avatar_color": "#FF5733",
"external_workspace_id": "mkt-workspace-001",
"auto_extract_enabled": false
},
"relationships": {
"owner": {
"data": {
"type": "people",
"id": "temp-id1"
}
}
},
"included": {
"owner": {
"data": {
"type": "people",
"id": "temp-id1",
"attributes": {
"first_name": "Sophie",
"last_name": "Martin"
}
}
}
}
}'
{
"data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attributes": {
"name": "<string>",
"desription": "<string>",
"external_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"avatar_color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"owner": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
},
"included": [
{
"type": "peoplex",
"id": "temp-people1",
"attributes": {
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"created_at": "<string>",
"updated_at": "<string>"
}
}
]
}
}
Bearer token for authentication
Show child attributes
Workspace created successfully
Show child attributes