You are here:
Campaign APIs
Vlocity Relationship Manager enables sales advisors to create a call list
campaign from customer contacts that Vlocity IQ has identified as potentially
interested in a [document]. The Campaign APIs enable you to create and
interact with these campaigns. POSTing to the /campaign resource
streamlines creating the call list campaigns, with interested contacts and relevant
documents attached in one API call. PUT updates the campaign status and members. GET
accesses one or more campaigns that the current user has created from a given
document.
Campaign APIs include the following:
- Create Campaign
Create a campaign. Create a custom campaign member status. Return campaign members with default status and a campaign content document, if provided. The primary content document is also stamped at the campaign level. - Get Campaign
Given the content document and the owner, return a list of campaign IDs and campaign names that already have content documents attached. - Update Campaign
Given a campaign, a user can update member status, contacts, and content documents associated with the campaign. - Create Campaign Email Message
Send an email message associated with a campaign. - Delete Campaign Member
Remove the member specified by the member ID from the campaign. - Get Campaign Attachments
Get the attachments on the campaign. - Get Campaign Email Templates
Get all of the predefined email templates in the org. - Get Campaign Member List
Get all of the predefined email templates in the org. - Get Campaign Member Stats
Get campaign detail information and optional member statistics, such as member counts distribution by member status. - Get Campaign Member Status
Get the list of campaign member status values. - Update Campaign Field
Update campaign detail fields. - Update Campaign Member
Update the campaign member status or targetCallDate. - Update Campaign Member Status
Add or modify a list of campaign member status values.
Did this article solve your issue?
Let us know so we can improve!
