Editing a segment

Modifies the specified segment.

Request

PUT

https://api-audience.yandex.com/v1/management/segment/{segmentId}

Path parameters

Name

Description

segmentId*

Type: integer<int32>

ID of the segment that you want to edit.

Body

application/json

{
    "segment": {
        "name": "string"
    }
}

Name

Description

segment

Type: SegmentName

The segment with the specified parameters.

SegmentName

The segment with the specified parameters.

Name

Description

name*

Type: string

Segment name.

Responses

200 OK

Body

application/json

{
    "segment": {
        "id": 0,
        "name": "string",
        "type": "string",
        "status": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "owner": "string"
    }
}

Name

Description

segment

Type: BaseSegment

The segment description by type.

BaseSegment

The segment description by type.

Name	Description
name*	Type: string Segment name.
create_time	Type: string<date-time> The time of segment creation.
id	Type: integer<int32> ID of the segment. Specify this parameter when updating a segment.
owner	Type: string The username of the segment owner.
status	Type: string Status of processing the segment. Acceptable values: `uploaded` – The segment with the user's data has been uploaded. `is_processed` – The segment with the specified parameters is being processed. `processed` – Uploading and processing the segment is complete. The segment is ready to use. `processing_failed` – Processing the segment failed with an error. `is_updated` — The segment is updated. `few_data` – The segment doesn't have enough data.
type	Type: string Segment type. Acceptable values: `uploading`: A segment created from a file with user data. `metrika`: A segment imported from Yandex Metrica. `appmetrica`: A segment imported from AppMetrica. `lookalike`: A segment of users who "look like" one of the client's other segments (uses the "lookalike" technology). `geo`: A segment based on location data for polygons and circles. `pixel`: A segment created using a tracking pixel.

Was the article helpful?

Recalculating a segment

Deleting a segment