For more information on using API

GET https://webapi.mymarketing.co.il/api/campaigns/{id}/details

Get campaign details

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Campaign id.Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id int the URL)

integer

Required

Body Parameters

None.

Response Information

Resource Description

ApiCampaignDetails

Name

Description

Type

Additional information

name

The campaign's name. Internal use only.

string

Required

subject

Campaign Subject

string

Required

user_profile_id

User profile ID. Required only in a Post endpoint. The email address of which the message will be sent from. Can be found using the endpoint "Get the account emails sending profiles" or in the UI (go to Emails -> Sending Profiles -> inspect/F12)

integer
google_analytics_name

Integrate your campaigns with google analytics. The campaign must be in English with no special characters or spaces. please note: if already have utm on your links - the integration will not work and the link might not be reachable

string
content_category_id

Catalog the campaigns to categories. Categories IDs can be found using the endpoint "Get the account's categories". If you remove the parameter, the catagory would automatically be the default category

integer
preheader

Short summary text that follows the subject line when viewing an email from the inbox. If you use A/B testing - it will be identical to both versions

string
predictive_delivery

Specify if predictive delivery is enabled. If you don't have predictive delivery feature in your account - remove this parameter

boolean

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "subject": "sample string 2",
  "user_profile_id": 1,
  "google_analytics_name": "sample string 3",
  "content_category_id": 1,
  "preheader": "sample string 4",
  "predictive_delivery": true
}

application/xml, text/xml

Sample: 
<ApiCampaignDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <add_statistics i:nil="true" />
  <content_category_id>1</content_category_id>
  <google_analytics_name>sample string 3</google_analytics_name>
  <name>sample string 1</name>
  <predictive_delivery>true</predictive_delivery>
  <preheader>sample string 4</preheader>
  <segmentation_id>1</segmentation_id>
  <sub_account_id>1</sub_account_id>
  <subject>sample string 2</subject>
  <user_profile_id>1</user_profile_id>
</ApiCampaignDetails>