GET v3/automatedcampaigns/{automatedCampaignId}

https://api.questline.com/v3/automatedcampaigns/{automatedCampaignId}

Gets an automated campaign.

Request Information

URI Parameters

Name Description Type Additional Info
automatedCampaignId The ID of the automated campaign. integer Required

Body Parameters

None.

Expands

Name Description Usage
steps Retrieves the related steps. GET v3/automatedcampaigns/{automatedCampaignId}?expand=steps

Response Information

Resource Description

GetAutomatedCampaignResponseV3
Name Description Type Additional Info
AutomatedCampaign The automated campaign. AutomatedCampaignV3 None.
Error The response error, if any. ResponseErrorV3 None.

Response Formats

application/json, text/json

Sample:

{
  "AutomatedCampaign": {
    "AutomatedCampaignId": 4,
    "Created": "2024-11-21T11:22:05.7895303+00:00",
    "IsMultipass": true,
    "Name": "sample string 3",
    "Status": "sample string 5",
    "Steps": [
      {
        "AutomatedCampaignStepId": 1,
        "AutomatedCampaignId": 2,
        "RunOrder": 3,
        "StepType": "sample string 4"
      },
      {
        "AutomatedCampaignStepId": 1,
        "AutomatedCampaignId": 2,
        "RunOrder": 3,
        "StepType": "sample string 4"
      }
    ],
    "SubscriberCounts": {
      "Completed": 1,
      "InProgress": 2,
      "New": 3,
      "Total": 4
    },
    "Type": "sample string 6"
  },
  "Error": {
    "ErrorId": 1,
    "ErrorMessage": "sample string 1"
  }
}

text/javascript, application/javascript, application/json-p

Sample:

/**/ typeof  === 'function' && ({"AutomatedCampaign":{"AutomatedCampaignId":4,"Created":"2024-11-21T11:22:05.7895303+00:00","IsMultipass":true,"Name":"sample string 3","Status":"sample string 5","Steps":[{"AutomatedCampaignStepId":1,"AutomatedCampaignId":2,"RunOrder":3,"StepType":"sample string 4"},{"AutomatedCampaignStepId":1,"AutomatedCampaignId":2,"RunOrder":3,"StepType":"sample string 4"}],"SubscriberCounts":{"Completed":1,"InProgress":2,"New":3,"Total":4},"Type":"sample string 6"},"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});