Segment

get

Authorizations

bearer & teamId

Query parameters

Hidden ModelstringOptional

Responses

200

Successful

application/json

stringOptional

403

Forbidden

application/json

500

Internal Server Error

application/json

get/segment

HTTPcURLJavaScriptPython

GET /v1/segment HTTP/1.1
Host: api.edgetag.io
Accept: */*

text

post

Authorizations

bearer & teamId

Body

application/json

namestringRequired

tagIdstringRequired

definitionobject · definitionRequired

bootstrapShopifybooleanOptional

Responses

200

Successful

application/json

segmentIdstringRequired

coverageDaysintegerRequired

400

Bad Request

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post/segment

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "tagId": "text",
  "definition": {},
  "bootstrapShopify": true
}

{
  "segmentId": "text",
  "coverageDays": 1
}

get

Authorizations

bearer & teamId

Path parameters

segmentIdstringRequired

Responses

200

Successful

application/json

segmentIdstringRequired

namestringRequired

statusstringRequired

definitionobject · definitionRequired

bootstrapShopifybooleanRequired

lastEventTsstring · dateOptional

createdAtstring · dateRequired

updatedAtstring · dateRequired

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

get/segment/{segmentId}

HTTPcURLJavaScriptPython

GET /v1/segment/{segmentId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "segmentId": "text",
  "name": "text",
  "status": "text",
  "definition": {},
  "bootstrapShopify": true,
  "lastEventTs": "2026-08-09",
  "createdAt": "2026-08-09",
  "updatedAt": "2026-08-09"
}

put

Authorizations

bearer & teamId

Body

application/json

object · Hidden ModelOptional

Responses

200

Successful

application/json

stringOptional

400

Bad Request

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

put/segment/{segmentId}

HTTPcURLJavaScriptPython

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

{}

text

delete

Authorizations

bearer & teamId

Responses

200

Successful

application/json

stringOptional

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

delete/segment/{segmentId}

HTTPcURLJavaScriptPython

DELETE /v1/segment/{segmentId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text

get

Authorizations

bearer & teamId

Responses

200

Successful

application/json

stringOptional

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

get/segment/audience-providers/{tagId}

HTTPcURLJavaScriptPython

GET /v1/segment/audience-providers/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text

get

Authorizations

bearer & teamId

Responses

200

Successful

application/json

stringOptional

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

get/segment/channel-defaults/{tagId}

HTTPcURLJavaScriptPython

GET /v1/segment/channel-defaults/{tagId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

text

put

Authorizations

bearer & teamId

Body

application/json

object · Hidden ModelOptional

Responses

200

Successful

application/json

stringOptional

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

put/segment/channel-defaults/{tagId}

HTTPcURLJavaScriptPython

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

{}

text

get

Authorizations

bearer & teamId

Path parameters

segmentIdstringRequired

Responses

200

Successful

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

get/segment/{segmentId}/destination

HTTPcURLJavaScriptPython

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-08-09"
    }
  ]
}

post

Authorizations

bearer & teamId

Path parameters

segmentIdstringRequired

Body

application/json

providerstring · enumRequiredPossible values:

audienceNamestringRequired

audienceTypestringRequired

frequencystringOptional

channelNamestringOptional

Responses

200

Successful

application/json

segmentDestinationIdstringRequired

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post/segment/{segmentId}/destination

HTTPcURLJavaScriptPython

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

{
  "provider": "facebook",
  "audienceName": "text",
  "audienceType": "text",
  "frequency": "text",
  "channelName": "text"
}

{
  "segmentDestinationId": "text"
}

get

Authorizations

bearer & teamId

Responses

200

Successful

application/json

stringOptional

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

get/segment/{segmentId}/detail

HTTPcURLJavaScriptPython

GET /v1/segment/{segmentId}/detail HTTP/1.1
Host: api.edgetag.io
Accept: */*

text

delete

Authorizations

bearer & teamId

Path parameters

segmentDestinationIdstringRequired

Responses

200

Successful

application/json

segmentDestinationIdstringRequired

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

delete/segment/destination/{segmentDestinationId}

HTTPcURLJavaScriptPython

DELETE /v1/segment/destination/{segmentDestinationId} HTTP/1.1
Host: api.edgetag.io
Accept: */*

{
  "segmentDestinationId": "text"
}