Segment - Delete All Records

POST

/segments/v2/{bucket}/segment/{uid}/action/delete

Creates a new resultset from the segment and deletes all records within it. This is an asynchronous operation that returns a notification URI to track progress.

Parameters

Path Parameters

bucket

required

The bucket (client) name

string

Example

example

uid

required

Usually the final element in the URI, an alphanumeric unique identifier

string

Example

6305f074683e800f3abe809e

Query Parameters

rules

Additional rules to filter the segment before deletion

object

safe_mode

Whether to run in safe mode (additional validation checks)

boolean

batch_size

Number of records to process in each batch

integer

default: 100 <= 2500

verbose

Whether to return detailed progress information

boolean

Responses

200

Successfully initiated bulk delete operation

object

notification_uri

URI of the notification that will track delete progress

string

Example

/example/person/6305f074683e800f3abe809e/

lambda_params

object

uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

rules

object

safe_mode

boolean

batch_size

integer

400

Bad request error

object

description

A human readable description of the error

string

error

A concise error message

string

type

A machine readable error type

string

Example

{
  "error": {
    "param": "batch_size",
    "message": "Batch size must be less than 2500"
  }
}

401

Authentication error