Skip to main content
PATCH
Partial update a segment

Authorizations

asapp-api-id
string
header
required
asapp-api-secret
string
header
required

Path Parameters

segmentId
string
required

Identifier of the segment

Body

application/json

Update a segment

name
string

The name of the segment

Example:

"Chat segment"

query
object

A query that defines which conversations belong to this segment based on their metadata.

structuredDataFieldIds
string[]

Structured data fields ids

Response

Successfully updated the segment.

Segment

id
string

The id of the segment

name
string

The name of the segment

query
object

A query that defines which conversations belong to this segment based on their metadata.

structuredDataFieldIds
string[]

The ids of the structured data fields that will be used to generate the structured data for the conversation.