REST API - Accessing Campaigns

Version 2

    The REST API supports create, retrieve, update and delete operations for campaigns.

     

    Accessing Campaigns

    • GET  /assets/campaign/{id}?depth={depth}

     

    Response

    The response for this call looks as follows

     

    {
      "type": "Campaign",
      "currentStatus": "Draft",
      "id": "6",
      "createdAt": "1284079044",
      "createdBy": "9",
      "depth": "complete",
      "description": "add a description...",
      "folderId": "1132",
      "name": "Sample Campaign",
      "updatedAt": "1292311276",
      "updatedBy": "9",
      "actualCost": "0.00",
      "budgetedCost": "0.00",
      "campaignType": "",
      "isMemberAllowedReEntry": "true",
      "isReadOnly": "false",
      "product": "",
      "region": ""
    } 
    

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    type"Campaign"
    actualCostdecimalThe actual cost of the campaignInteger
    Requirement
    budgetedCostdecimalThe budgeted cost for the campaignInteger
    Requirement
    campaignTypestring
    crmIdstringThe unique id of the campaign in your CRM
    elementsList of Campaign Element
    endAtintegerThe campaign's end dateDateRequirement
    fieldValuesList of FieldValue
    isMember
    AllowedReEntry
    booleanDetermines whether a member can re-enter the campaignBoolean
    Requirement
    isReadOnlybooleanBoolean
    Requirement
    productstring
    regionstring
    startAtintegerThe campaign's start dateDateRequirement
    accessedAtintegerDateRequirement
    createdAtintegerReadOnlyDateRequirement
    createdByintegerReadOnlyIdRequirement
    currentStatusstring
    depthRequestDepthEnum
    Requirement
    descriptionstring
    folderIdintegerIdRequirement
    idintegerIdRequirement
    namestring
    permissionsInstance
    Permissions
    Enum
    Requirement
    scheduledForintegerDateRequirement
    sourceTemplateIdstring
    updatedAtintegerReadOnlyDateRequirement
    updatedByintegerReadOnlyIdRequirement

     

     

    Related Operations

    • POST :  /assets/campaign
    • PUT :  /assets/campaign/{id}
    • DELETE :  /assets/campaign/{id}
    • GET :  /assets/campaigns?depth={depth}&count={count}&page={page}&search={search}&orderBy={orderBy}&lastUpdatedAt={lastUpdatedAt}
    • GET :  /assets/campaigns/assets/campaigns/recent?depth={depth}&count={count}