Skip to content

APIs Outbound

The Lynn Proactive module has a set of APIs that allow you to manage some of its functionalities; they are RESTful and require an authorization token.

Available Apis

Campaigns

  • GetCampaigns: Returns the list of campaigns associated with the Tenant.

  • GetCampaign: Returns the information of a campaign given the Tenant and the campaign ID.

  • PostCampaign: Campaign creation.

  • PutCampaign: Campaign update.

  • DeleteCampaign: Delete a campaign.

  • StartCampaignExecution: Allows to start a campaign whose execution mode is Manual.

  • StopCampaignExecution: Allows to stop a campaign whose execution mode is Manual.

Contacts

  • GetContacts: Returns the list of contacts associated with a Tenant.

  • GetContact: Returns the information of a contact given the Tenant and the contact ID.

  • PostContact: Create a Contact.

  • PutContact: Update a contact.

  • DeleteContact: Delete a contact.

Blacklist**:

  • GetDnDContact: Returns a list with the information of the campaign in which the contact is in the blacklist.

  • SetDnDContactByCampaign: Adds a contact to the blacklist for a particular campaign.

  • SetDnDContactByCategory: Adds a contact to the blacklist for campaigns belonging to the same category.

  • ManageDnDByCampaign: Bulk blacklist management. Adds contacts and updates the status in the blacklist for a campaign. Returns the task id.

  • GetDndTaskStatus: Returns task information, after the execution of the ManageDnDByCampaign method.

Campaign Records

  • UploadCampaignDataByTenant: Allows the creation of campaign records from a .cpg file (See Contact_Template.cpg) associated with the Tenant.

  • GetCampaignDataByCampaign: Returns campaign