Set Member Status
# Not Recommended to Continue Using the Offline API!!!
# Description
Set member status
# Request Specification
Method: POST + application/json
Endpoint: https://${Cloud Domain}/cgi/crm/v2/data/update?thirdTraceId=${Random String}
# Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| corpAccessToken | String | Yes | corpAccessToken (returned via Get Token API (opens new window)) |
| corpId | String | Yes | corpId (returned via Get Token API (opens new window)) |
| currentOpenUserId | String | Yes | currentOpenUserId (returned via Query Employee by Phone API (opens new window)) |
| status | Int | Yes | Status (1: Disabled, 2: Enabled) |
| openUserId | String | No | Member ID (obtained via Query Employee by Phone). Either openUserId or openUserIds must be provided. |
| openUserIds | List[String] | No | Member IDs (obtained via Query Employee by Phone). Either openUserId or openUserIds must be provided. |
# Request Example
{
"corpAccessToken": "{corpAccessToken}",
"corpId": "{corpId}",
"openUserIds": [
"openUserId1",
"openUserId2"
],
"status": 1
}
# Response Parameters
| Parameter | Type | Description |
|---|---|---|
| traceId | string | Unique request ID |
| errorDescription | string | Error description |
| errorMessage | string | Error message |
| errorCode | Int | View Error Codes |
# Response Example
{
"traceId": "E-O.827xxxxxx",
"errorDescription": "success",
"errorMessage": "OK",
"errorCode": 0
}
# Notes
- Do not use the message field in the response for logical judgment, as errorMessage may change.