Bulk Operations

Perform bulk updates or deletes on tickets, customers, or articles. Max 100 items per request.

The Bulk Operation object

action string

Operation type "update" | "delete"

resource string

Resource type "tickets" | "customers" | "articles"

total integer

Total items processed

succeeded integer

Items successfully processed

failed integer

Items that failed

Endpoints

POST Bulk Operation

POST /api/v1/teams/{teamId}/bulk

Bulk Operation

Perform a bulk update or delete on up to 100 resources at once.

Request Body

action string required

Operation: update or delete

resource string required

Resource type

ids string[] required

Array of resource IDs

data object

Update fields (required for update action)

Code Examples

curl -X POST "https://www.cstar.help/api/v1/teams/{teamId}/bulk" \
  -H "Authorization: Bearer sk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"action":"update","resource":"tickets","ids":["tkt_1","tkt_2"],"data":{"status":"closed"}}'

Responses

200 Bulk result

{
  "success": true,
  "data": {
    "object": "bulk_result",
    "action": "update",
    "resource": "tickets",
    "total": 5,
    "succeeded": 5,
    "failed": 0,
    "errors": []
  }
}

401 Authentication failed — missing or invalid API key

{
  "success": false,
  "error": {
    "type": "authentication_error",
    "code": "authentication_required",
    "message": "Invalid or expired API key",
    "doc_url": "https://www.cstar.help/developers/api-reference#authentication",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}

403 Insufficient permissions — wrong key type or team access

{
  "success": false,
  "error": {
    "type": "authorization_error",
    "code": "insufficient_permissions",
    "message": "Secret key required for this endpoint",
    "doc_url": "https://www.cstar.help/developers/api-reference#authentication",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}

429 Rate limit exceeded

{
  "success": false,
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 60 seconds",
    "doc_url": "https://www.cstar.help/developers/api-reference#rate-limiting",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}