All API categories

    Segments API

    7 endpoints

    Audience segmentation.

    GET
    Auth Required

    segments.list

    segments.list

    Endpoint

    /admin/collection/{collectionId}/segments

    Parameters

    collectionId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SegmentList"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    segments.create

    segments.create

    Endpoint

    /admin/collection/{collectionId}/segments

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    SegmentRecord
    Required

    See SegmentRecord schema

    Responses

    200
    Success
    {
  "schema": "SegmentRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    segments.get

    segments.get

    Endpoint

    /admin/collection/{collectionId}/segments/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SegmentRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    PATCH
    Auth Required

    segments.update

    segments.update

    Endpoint

    /admin/collection/{collectionId}/segments/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required
    body
    body
    object
    Required

    Request body

    Responses

    200
    Success
    {
  "schema": "SegmentRecord"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    DELETE
    Auth Required

    segments.remove

    segments.remove

    Endpoint

    /admin/collection/{collectionId}/segments/{id}

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    segments.calculate

    segments.calculate

    Endpoint

    /admin/collection/{collectionId}/segments/{id}/calculate

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SegmentCalculateResult"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    segments.recipients

    segments.recipients

    Endpoint

    /admin/collection/{collectionId}/segments/{id}/recipients

    Parameters

    collectionId
    path
    string
    Required
    id
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "SegmentRecipientsResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found