Magidoc

Campaign
Interface

Fields

#

actions

PublicActionsResult !
Non-null

Fetch public actions. Can be used to display recent comments for example.

To allow-list action fields to be public, campaign.public_actions must be set to a list of strings in form action_type:custom_field_name, eg: ["signature:comment"] . XXX this cannot be set in API, you need to set in backend.

config

Json !
Non-null

Custom config map

contactSchema

ContactSchema !
Non-null

Schema for contact personal information

externalId

Int

External ID (if set)

id

Int !
Non-null

Campaign id

name

String !
Non-null

Internal name of the campaign

org

Org !
Non-null

Lead org

stats

CampaignStats !
Non-null

Statistics

status

CampaignStatus !
Non-null

Current status of the campaign

targets

[ Target ]

List MTT targets of this campaign

title

String !
Non-null

Full, official name of the campaign

Implementations

#

Implemented by PrivateCampaign , PublicCampaign .

Usages

#

References

#