Skip to content

Add Members (Deployment Plan)



POST /api/v1/workspace/member/batch_add

Overview

Add one/multiple members (Only supports Deployment Plan)

Body Request Parameters

Parameter Name Type Required Description
accountUUIDs array Y Account list
Example: ['acnt_xxxx32']
Allow empty: False
roleUUIDs array Y User role uuid list
Example: ['general', 'readOnly', 'role_xxxx32']
Allow empty: False

Parameter Additional Description

  • Request Parameter Description
Parameter Name Type Description
accountUUIDs array Account UUIDs in the site
roleUUIDs array Workspace role UUIDs
  • roleUUIDs Description
Role Description
wsAdmin Admin role
general Standard member role
readOnly Read-only role
role_xxx Custom role

Request Example

curl 'https://openapi.truewatch.com/api/v1/workspace/member/batch_add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"accountUUIDs": ["acnt_xxxx32"], "roleUUIDs": ["general","role_xxxx32"]}' \
--compressed

Response

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B6A69C1D-ED27-42C2-93FD-BC943F8675D2"
}