Modifying the data for a segment created from a file

Changes the data for the specified segment. When updating segments, you need to use the file structure that was used when the segment was loaded the first time.

Sample request

POST https://api-audience.yandex.com/v1/management/segment/111/modify_data?modification_type=addition
Content-Type: multipart/form-data; boundary=--------------------------5b2a52c5c90f668a
Context-Length: 331
--------------------------5b2a52c5c90f668a
Content-Disposition: form-data; name="file"; filename="data.tsv"
Content-Type: application/octet-stream

aaaaaaaa-bbbb-cccc-1111-222222222200
aaaaaaaa-bbbb-cccc-1111-222222222201
--------------------------5b2a52c5c90f668a--

Request

POST

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

Path parameters

Name

Description

segmentId

Type: integer

ID of the segment that you want to change.

Query parameters

Name

Description

modification_type

Type: string

Type of data change: add or delete data, overwrite the entire file. The added data must match the original format (hashed or unhashed information).

Type of data modification. Acceptable values:

subtraction — deleting data from the file.
addition — adding data to the file.
replace — completely overwriting the file.

Example: addition, subtraction, replace

check_size

Type: boolean

You can create segments with less than 100 records using this parameter. However, you can't use these segments for promotion in Yandex Direct until their size exceeds 100 records.

Default: true

Body

multipart/form-data

{
  "file": "example"
}

Name

Description

file

Type: string<binary>

Uploaded file with the updated data.

Example: example

Responses

200 OK

Body

application/json

{
  "segment": {
    "type": "example",
    "id": 0,
    "name": "example",
    "status": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "owner": "example",
    "hashed": true,
    "used_hashing_alg": "example",
    "content_type": "example"
  }
}

Name

Description

segment

Type: UploadingSegment

A segment created from a file with user data.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "hashed": true,
  "used_hashing_alg": "example",
  "content_type": "example"
}

BaseSegment

The segment description by type.

Name	Description
name	Type: string Segment name. Example: `example`
create_time	Type: string<date-time> The time of segment creation. Example: `2025-01-01T00:00:00Z`
id	Type: integer ID of the segment. Specify this parameter when updating a segment.
owner	Type: string The username of the segment owner. Example: `example`
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`: The segment has been uploaded and processed. The segment is ready to use. `processing_failed`: Segment processing has failed. `is_updated`: The segment is updating. `few_data`: The segment has insufficient data. Example: `example`
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. Example: `example`

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example"
}

UploadingSegment

A segment created from a file with user data.

All of 2 types

Type: BaseSegment

The segment description by type.

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example"
}

Type: object

content_type

Type: string

Type of file content. Acceptable values:

idfa_gaid: Device IDs.
mac: MAC addresses.
crm: CRM data.

Example: example

hashed

Type: boolean

Whether every string in the uploaded file is hashed. Acceptable values:

true: Hashed. - false: Unhashed.

used_hashing_alg

Type: string

The hashing algorithm used for the data is sent for hashed: true. Acceptable values: SHA256.

Alert

Starting January_2025, uploading new MD5 hashes is no longer supported. To upload new data, use SHA‑256.

Example: example

Example

{
  "hashed": true,
  "used_hashing_alg": "example",
  "content_type": "example"
}

Example

{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "hashed": true,
  "used_hashing_alg": "example",
  "content_type": "example"
}

Was the article helpful?

Changing the list of coordinates for a segment with the "geo-circles" type

Saving a segment created from a file