ComRaidComRaid Docs
API referenceSegments

Update segment

Partial update: omitted fields keep their current values. Empty `name` is 400. Saving rules with zero conditions is 400 (use Everyone). At most 50 conditions and 1,000 values per `in` list. Renaming onto an active Segment name returns 409 `segment_name_taken`.

PUT
/segments/{id}

Partial update: omitted fields keep their current values. Empty name is 400. Saving rules with zero conditions is 400 (use Everyone). At most 50 conditions and 1,000 values per in list. Renaming onto an active Segment name returns 409 segment_name_taken.

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Project API key (cr_sk_...)

Path Parameters

id*string
Formatuuid

Request Body

application/json
  1. body

Partial update body. Omitted fields keep their current values. When name is sent it must be non-empty. When rules is sent it must have at least one condition (at most 50) and in lists at most 1,000 values.

name?string
Length1 <= length
description?string
rules?

Response Body

Updated

application/json
  1. response
segment_id*string
Formatuuid
status*string
Value in"active""archived"
updated_at*string
Formatdate-time
Example Request
curl -X PUT 'https://api.comraid.io/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "segment_id": "0dbbf761-5b2d-4647-8bfa-2b714456749c",  "status": "active",  "updated_at": "2019-08-24T14:15:22Z"}