Update segment

Update a segment.

SecurityTdApikeyAuth
Request
path Parameters
audienceId
required
integer <int64>

Master Segment id of the segment

segmentId
required
integer <int64>

ID of Segment that needs to be updated

Request Body schema: application/json
audienceId
integer <int64>
name
string
realtime
boolean
Deprecated

use kind instead

kind
integer

0: batch, 1: realtime, 2: funnel_stage

object

required if creating segment as a rule of funnel_stage

description
string
segmentFolderId
integer <int64>
partial_v5_rule.yaml-v5IonRule-ionRule (object) or (object or null) (partial_v5_rule.yaml-v5IonRule)
countPopulation
boolean
Responses
200

successful operation

400

Given parameters are not valid

401

Unauthorized; You don't provide valid credentials. Maybe you didn't specify valid TD's Master API Key as 'TD1 {Your TD Master API Key}'.

403

Requested resource or action is not allowed because you don't have sufficient permissions

404

The specified resource was not found

4XX

There is a high possibility of error of the authentication system. Please check the contents and authority of the key. Please contact the TD support team if you do not resolve it.

5XX

System error. Because there is a possibility of a temporary error due to network trouble and so on, we recommend several times retry on request side. Please contact the TD support team if you do not resolve it.

put/audiences/{audienceId}/segments/{segmentId}
Request samples
application/json
{
  • "audienceId": 0,
  • "name": "string",
  • "realtime": true,
  • "kind": 0,
  • "funnel_stage": {
    },
  • "description": "string",
  • "segmentFolderId": 0,
  • "rule": {
    },
  • "countPopulation": true
}
Response samples
application/json
{
  • "audienceId": "string",
  • "id": "string",
  • "name": "string",
  • "realtime": true,
  • "kind": 0,
  • "description": "string",
  • "segmentFolderId": "string",
  • "population": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "rule": { }
}