Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
workspace
/
update
Update Workspace
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/workspace/update \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspace_id": "1234567890",
  "name": "My Workspace",
  "auth_scope": 1,
  "description": "This is a workspace for invoice processing",
  "callback_url": "https://example.com/callback",
  "callback_retry_time": 3
}
'
{
  "code": 200,
  "msg": "<string>"
}

Authorizations

x-ti-app-id
string
header
required
x-ti-secret-code
string
header
required

Body

application/json
workspace_id
string
required

Workspace ID

Example:

"1234567890"

name
string
required

Workspace name

Maximum string length: 50
Example:

"My Workspace"

auth_scope
enum<integer>
required

Collaboration scope 0: Visible only to self 1: Visible to enterprise members

Available options:
0,
1
Example:

1

description
string

Workspace description

Maximum string length: 500
Example:

"This is a workspace for invoice processing"

callback_url
string

Callback URL

Example:

"https://example.com/callback"

callback_retry_time
integer

Callback retry count

Required range: 1 <= x <= 3
Example:

3

Response

200 - application/json

Successfully updated workspace

code
integer
required

Status code

Example:

200

msg
string
required

Status description