For the complete documentation index, see llms.txt. This page is also available as Markdown.

Segment

get
Authorizations
Query parameters
Hidden ModelstringOptional
Responses
200

Successful

application/json
stringOptional
get/segment
GET /v1/segment HTTP/1.1
Host: api.edgetag.io
Accept: */*
text
post
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
post/segment
POST /v1/segment HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/segment/tier
GET /v1/segment/tier HTTP/1.1
Host: api.edgetag.io
Accept: */*
text
get
Authorizations
Path parameters
segmentIdstringRequired
Responses
200

Successful

application/json
segmentIdstringRequired
namestringRequired
statusstringRequired
definitionobject · definitionRequired
bootstrapShopifybooleanRequired
lastEventTsstring · dateOptional
createdAtstring · dateRequired
updatedAtstring · dateRequired
get/segment/{segmentId}
GET /v1/segment/{segmentId} HTTP/1.1
Host: api.edgetag.io
Accept: */*
{
  "segmentId": "text",
  "name": "text",
  "status": "text",
  "definition": {},
  "bootstrapShopify": true,
  "lastEventTs": "2026-01-01",
  "createdAt": "2026-01-01",
  "updatedAt": "2026-01-01"
}
put
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
put/segment/{segmentId}
PUT /v1/segment/{segmentId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
delete
Authorizations
Responses
200

Successful

application/json
stringOptional
delete/segment/{segmentId}
DELETE /v1/segment/{segmentId} HTTP/1.1
Host: api.edgetag.io
Accept: */*
text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/segment/audience-providers/{tagId}
GET /v1/segment/audience-providers/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*
text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/segment/channel-defaults/{tagId}
GET /v1/segment/channel-defaults/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*
text
put
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
put/segment/channel-defaults/{tagId}
PUT /v1/segment/channel-defaults/{tagId} HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
get
Authorizations
Path parameters
segmentIdstringRequired
Responses
200

Successful

application/json
get/segment/{segmentId}/destination
GET /v1/segment/{segmentId}/destination HTTP/1.1
Host: api.edgetag.io
Accept: */*
{
  "destinations": [
    {
      "segmentDestinationId": "text",
      "provider": "text",
      "audienceName": "text",
      "audienceType": "text",
      "frequency": "text",
      "lastSyncedAt": "2026-01-01"
    }
  ]
}
post
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
post/segment/{segmentId}/destination
POST /v1/segment/{segmentId}/destination HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
get
Authorizations
Query parameters
Hidden ModelstringOptional
Responses
200

Successful

application/json
stringOptional
get/segment/{segmentId}/sync-history
GET /v1/segment/{segmentId}/sync-history HTTP/1.1
Host: api.edgetag.io
Accept: */*
text
get
Authorizations
Responses
200

Successful

application/json
stringOptional
get/segment/{segmentId}/detail
GET /v1/segment/{segmentId}/detail HTTP/1.1
Host: api.edgetag.io
Accept: */*
text
post
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
post/segment/activation
POST /v1/segment/activation HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
put
Authorizations
Body
object · Hidden ModelOptional
Responses
200

Successful

application/json
stringOptional
put/segment/onboarding-opt-in
PUT /v1/segment/onboarding-opt-in HTTP/1.1
Host: api.edgetag.io
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
text
delete
Authorizations
Path parameters
segmentDestinationIdstringRequired
Responses
200

Successful

application/json
segmentDestinationIdstringRequired
delete/segment/destination/{segmentDestinationId}
DELETE /v1/segment/destination/{segmentDestinationId} HTTP/1.1
Host: api.edgetag.io
Accept: */*
{
  "segmentDestinationId": "text"
}

Last updated

Was this helpful?