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

Audience Segments

Operations related to Audience Segments, the user groups defined based on criteria for targeting and activation, supporting multiple types including Standard, Edge, Static, Lookalike, and Activation segments.

Get Audience Segment by Blast Campaign

get
/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments
Path parameters
campaign_idinteger · int64Required
blast_idinteger · int64Required
Responses
200

Success !

application/json
first_resultintegerRequired
countintegerRequired
totalintegerRequired
statusstring · enumRequiredPossible values:
max_resultsintegerRequired
get/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments
GET /v1/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "first_result": 1,
  "count": 1,
  "total": 1,
  "data": [
    {
      "id": "text",
      "audience_segment_id": "text",
      "name": "text",
      "technical_name": "text",
      "exclude": false
    }
  ],
  "status": "ok",
  "max_results": 1
}

Create Audience Segment by Blast Campaign

post
/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments
Path parameters
campaign_idinteger · int64Required
blast_idinteger · int64Required
Body
idstringRead-onlyRequired
audience_segment_idstringRequired
namestringRead-onlyRequired
technical_namestringRead-onlyRequired
excludebooleanRequiredDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
post/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments
POST /v1/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "audience_segment_id": "text",
  "exclude": false
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "audience_segment_id": "text",
    "name": "text",
    "technical_name": "text",
    "exclude": false
  }
}

Find Audience Segment by Id

get
/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id}
Path parameters
campaign_idinteger · int64Required
blast_idinteger · int64Required
idinteger · int64Required
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
get/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id}
GET /v1/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok",
  "data": {
    "id": "text",
    "audience_segment_id": "text",
    "name": "text",
    "technical_name": "text",
    "exclude": false
  }
}

Update Audience Segment by Id

put
/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id}
Path parameters
campaign_idinteger · int64Required
blast_idinteger · int64Required
idinteger · int64Required
Body
idstringRead-onlyRequired
audience_segment_idstringRequired
namestringRead-onlyRequired
technical_namestringRead-onlyRequired
excludebooleanRequiredDefault: false
Responses
200

Success !

application/json
statusstring · enumRequiredPossible values:
put/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id}
PUT /v1/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id} HTTP/1.1
Host: api.mediarithmics.local
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "audience_segment_id": "text",
  "exclude": false
}
{
  "status": "ok",
  "data": {
    "id": "text",
    "audience_segment_id": "text",
    "name": "text",
    "technical_name": "text",
    "exclude": false
  }
}

Find Audience Segment by Id

delete
/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id}
Path parameters
campaign_idinteger · int64Required
blast_idinteger · int64Required
idinteger · int64Required
Responses
200

Success response

application/json
statusstring · enumRequiredPossible values:
delete/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id}
DELETE /v1/email_campaigns/{campaign_id}/email_blasts/{blast_id}/audience_segments/{id} HTTP/1.1
Host: api.mediarithmics.local
Accept: */*
{
  "status": "ok"
}

Last updated

Was this helpful?