Skip to main content

POST - Batch change user status

Batch change user status

Request​

  • Method: POST
  • Endpoint: /users/batch/change-status
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: batch-change-user-status

Authorization​

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Request Body​

Required: no Content-Type: application/json Schema: Array<UserStatusChangeRequest>

Schema
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/UserStatusChangeRequest"
  }
}

Example: example-1​

[
  {
    "id": "be63c536-6cf3-4866-8970-37a956e3f403",
    "status": "ARCHIVED"
  },
  {
    "id": "53262fe0-adf9-4a64-8040-e1eb9db72213",
    "status": "ACTIVE"
  }
]

Responses​

204 No content​

400 Bad Request​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "invalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

401 Unauthorized​

404 Not Found​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

500 Internal Server Error​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}