Workspaces

This API gives you the accessibility to create a new workspace in your TexAu account.

post

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

workspaceNamestringrequired

The workspace name

Example: My Workspace

orgUserIdstringrequired

The orgUserId

Example: 5e9f8f8f8f8f8f8f8f8f8f8

organisationIdstringrequired

The organisationId

Example: 5e9f8f8f8f8f8f8f8f8f8f8

timezonestringoptional

The TimeZone

Example: Asia/Kolkata

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/workspaces' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "workspaceName": "My Workspace",
    "orgUserId": "5e9f8f8f8f8f8f8f8f8f8f8",
    "organisationId": "5e9f8f8f8f8f8f8f8f8f8f8",
    "timezone": "Asia/Kolkata"
  }'

201

401

403

406

422

500

201

{
  "success": true,
  "message": "Workspace created successfully",
  "data": {
    "workspaceId": "text",
    "orgUserId": "text"
  }
}

Workspace created successfully

This API gives you the accessibility to change your workspace name.

put

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

workspaceNamestringrequired

The New Workspace Name

Example: New Workspace

organisationIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/public/workspaces/{workspaceId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "workspaceName": "New Workspace",
    "organisationId": "text"
  }'

200

401

403

404

422

500

200

No body

Workspace update successful

This API gives you accessibility of deleting the workspace

Deleting the workspace will delete all workflow and their results

delete

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/public/workspaces/{workspaceId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

422

500

200

No body

Workspace deleted successfully