CROWDMANAGERCROWDMANAGER

Campaign Apps

Description

A campaign app resource represents any campaign that was created in the CROWDMANAGER suite. For now we only provide read only integration but allowes partners to import data on their campaigns and their participants into their systems.

Fields

Name Description Type/Supported Values Supported Methods
id Id of the Campaign App long GET
guid Unique identifier of the Campaign App. string GET
facebookAppId Id of app on facebook long GET
fromDateTime Start time of the campaign. datetime GET
campaignAppTypeId Type of campaign. int GET
campaignAppTemplateId Template used for the campaign. long GET
toDateTime (optional) End time of the campaign. datetime GET
smartLinkId Id of a Smart Link used for the landing page of the given campaign. long GET
status Workflow status in which it currently is. "planning", "ready", "running", "ended", "archived" GET
isValid Determines if campaign is currently valid or not to go live. boolean GET
ownerActorId Id of owner actor long GET
tenantId Id of tenant long GET
subtype Subtype of the campaign string GET
visualType VisualType of the campaign string GET
isRemoved If the campaign is archived. boolean GET
_type Type of the Campaign. string GET
name Internally used name of the Campaign used to distinguish it from another in campaign administration. string GET
createdDateTime Time of creation. datetime GET
createdById Id of creator. long GET
updatedDateTime Time of last updated. datetime GET
updatedById Id of updater long GET
isDisabled If the campaign is disabled. boolean GET
language Language code for the language that was set for the Campaign. string GET
links.campaignappauthenticationoptions Id of authentication options CampaignAppAuthenticationOption GET

CampaignAppAuthenticationOptions

Name Description Type/Supported Values
id Id of theCampaignAppAuthenticationOptions long
type Authentication type, as for example: "myPage", "form", "simpleMobile", "facebook", "sportsAlliance", etc. It is possible to extend the authentication types by adding OIDC Single Sign On integrations string
isenabled True if the campaign has that authentication type enabled boolean

Permissions

Read a list

List the campaigns apps for given organization id and provided query parameters.

Endpoint

GET https://api.crowdmanager.io/v2/{organization-id}/campaign/campaignapps

QUERY Parameters

| Name | Description | Required | | --- | --- | --- | --- | | pageSize | Maximum returned campaign apps. Defaults to 50. | False | | pageIndex | Skip certain amount of pages. Zero indexed.| False | | statuses | Display campaign apps with certain status. | False |

Example

Request

GET https://api.crowdmanager.io/v2/1201/campaign/campaignapps?pageSize=20&pageIndex=1&statuses=planning
Authorization: Basic aaabbbccc111222333
Accept: application/vnd.api+json

Response

{
   "campaignApps":[
      {
         "id":"5561995",
         "href":"https://api.crowdmanager.io/v2/1201/campaign/campaignapps/5561995",
         "type":"campaignApps",
         "guid":"2c65bc56-cfe1-4af9-be84-73c24f45ead8",
         "ownerActorId":1201,
         "campaignAppTypeId":2,
         "campaignAppTemplateId":2,
         "smartLinkId":4326,
         "status":"planning",
         "isValid":false,
         "facebookAppId":"564546456465456",       
         "isRemoved":false,
         "_type":"CampaignSystem",
         "name":"SportsMatchVoting Today",
         "createdDateTime":"2015-09-14T13:12:59.537Z",
         "createdById":1308,
         "updatedById":1308,
         "version":0,
         "isDisabled":false,
         "language":"no",
         "links": {
         "campaignAppAuthenticationOptions": [
            "1",
            "2"
            ]
         }
      },
      {
         "id":"5542433",
         "href":"https://api.crowdmanager.io/v2/1201/campaign/campaignapps/5542433",
         "type":"campaignApps",
         "guid":"cecd0643-29df-47e6-a68d-413e87b90560",
         "ownerActorId":1201,
         "campaignAppTypeId":2,
         "campaignAppTemplateId":2,
         "smartLinkId":4256,
         "status":"planning",
         "isValid":false,
         "facebookAppId":"564546456465456",         
         "isRemoved":false,
         "_type":"CampaignSystem",
         "name":"ImageUpload Tomorrow",
         "createdDateTime":"2015-09-11T10:36:38.007Z",
         "createdById":1308,
         "updatedDateTime":"2015-09-11T10:36:45.16Z",
         "updatedById":1308,
         "version":0,
         "isDisabled":false,
         "language":"no",
         "links": {
         "campaignAppAuthenticationOptions": [
            "1",
            "2"
            ]
         }
      }
   ],
   "links": {
    "campaignApps.campaignAppAuthenticationOptions": {
      "href": "http://localhost/v2/9111//",
      "type": "campaignAppAuthenticationOptions"
    }
  },
  "linked": {
    "campaignAppAuthenticationOptions": [
      {
        "id": "1",
        "type": "campaignAppAuthenticationOptions",
        "isEnabled": true,
        "_type": "form"
      },
      {
        "id": "2",
        "type": "campaignAppAuthenticationOptions",
        "isEnabled": true,
        "_type": "secureMobile"
      }
    ]
  }
}

Read

Returns a single Campaign for given id.

Endpoint

GET https://api.crowdmanager.io/v2/{organization-id}/campaign/campaignapps/{id}

Example

Request

GET https://api.crowdmanager.io/v2/1201/campaign/campaignapps/5561995
Authorization: Basic aaabbbccc111222333
Accept: application/vnd.api+json

Response

{  
   "campaignApps":{  
      "id":"5561995",
      "href":"https://api.crowdmanager.io/v2/1201/campaign/campaignapps/5561995",
      "type":"campaignApps",
      "guid":"2c65bc56-cfe1-4af9-be84-73c24f45ead1",
      "ownerActorId":1201,
      "campaignAppTypeId":2,
      "campaignAppTemplateId":2,
      "smartLinkId":4326,
      "status":"planning",
      "isValid":false,
      "facebookAppId":"564546456465456",      
      "isRemoved":false,
      "_type":"CampaignSystem",
      "name":"SportsMatchVoting Today",
      "createdDateTime":"2015-09-14T13:12:59.537Z",
      "createdById":1308,
      "updatedById":1308,
      "version":0,
      "isDisabled":false,
      "language":"no",
      "shareLinkUrl": "http://www.shrt1.com",
      "links": {
         "campaignAppAuthenticationOptions": [
            "1",
            "2"
      ]
      }
   },
   "links": {
    "campaignApps.campaignAppAuthenticationOptions": {
      "href": "http://localhost/v2/9111//",
      "type": "campaignAppAuthenticationOptions"
    }
  },
  "linked": {
    "campaignAppAuthenticationOptions": [
      {
        "id": "1",
        "type": "campaignAppAuthenticationOptions",
        "isEnabled": true,
        "_type": "form"
      },
      {
        "id": "2",
        "type": "campaignAppAuthenticationOptions",
        "isEnabled": true,
        "_type": "secureMobile"
      }
    ]
  }
}