Workspaces

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

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

workspaceNamestringRequired

The workspace name

Example: My Workspace

orgUserIdstringRequired

The orgUserId

Example: 5e9f8f8f8f8f8f8f8f8f8f8

organisationIdstringRequired

The organisationId

Example: 5e9f8f8f8f8f8f8f8f8f8f8

timezonestringOptional

The TimeZone

Example: Asia/Kolkata

Responses

201

Workspace created successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

406

Workspace limit reached, can not create new workspace

422

Requested workspace does not belongs to you

500

Error in creating workspace

post

/api/v1/public/workspaces

HTTPcURLJavaScriptPython

POST /api/v1/public/workspaces HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "workspaceName": "My Workspace",
  "orgUserId": "5e9f8f8f8f8f8f8f8f8f8f8",
  "organisationId": "5e9f8f8f8f8f8f8f8f8f8f8",
  "timezone": "Asia/Kolkata"
}

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

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

put

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspaceIdstringRequired

The workspace id

Example: 679cb332c77f9b9ef3264d56

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

workspaceNamestringRequired

The New Workspace Name

Example: New Workspace

organisationIdstringRequired

Responses

200

Workspace update successful

No content

401

Unauthorized access

403

Your plan does not have API access

404

Workspace does not exist

422

Requested workspace does not belongs to you

500

Error in updating workspace

put

/api/v1/public/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

PUT /api/v1/public/workspaces/{workspaceId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "workspaceName": "New Workspace",
  "organisationId": "text"
}

No content

This API gives you accessibility of deleting the workspace

Deleting the workspace will delete all workflow and their results

delete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workspaceIdstringRequired

The workspace id

Example: 679cb332c77f9b9ef3264d56

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Workspace deleted successfully

No content

401

Unauthorized access

403

Your plan does not have API access

404

Workspace does not exist

422

Requested workspace does not belongs to you

500

Error in deleting workspace

delete

/api/v1/public/workspaces/{workspaceId}

HTTPcURLJavaScriptPython

DELETE /api/v1/public/workspaces/{workspaceId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Accept: */*

No content