Overview

Skill Level: Any

Prerequisites

This interface is used to add a Contact to a Program. The Contact will be added to the beginning of the Program.

This operation will typically be used in conjunction with either the AddRecipient or UpdateRecipient operation. After adding or updating a Contact using those operations, the RecipientId in the response can be used in the CONTACT_ID element in a subsequent AddContactToProgram API request.

A valid jsessionid must be provided to authenticate the request.

The contact will not be added if any of the following scenarios exist:

  • The specified CONTACT_ID is already an active participant in the Program.
  • The specified CONTACT_ID is NOT in the database associated with the Program.
  • The specified PROGRAM_ID is Pending and not accepting new Contacts.
  • The specified PROGRAM_ID is Inactive and not accepting new Contacts.
  • The specified PROGRAM_ID is Completed and not accepting new Contacts.
  • The specified PROGRAM_ID has a Last Contact Add Date in the past.
  • The specified PROGRAM_ID does not exist.

Step-by-step

  1. Syntax of the request and response SOAP for AddContactToProgram

    Operation  <AddContactToProgram>   
    Elements  PROGRAM_ID  Unique ID of the program. 
      CONTACT_ID  Unique ID of the contact being added to the program. 
    Example¬† <soapenv:Envelope xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”
    xmlns:sil=”SilverpopApi:EngageService.SessionHeader”
    xmlns:sil1=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <soapenv:Header>
    <sil:sessionHeader>
    <sil:sessionid>A64604ED696D782CF898BA2F701F743E</sil:sessionid>
    </sil:sessionHeader>
    </soapenv:Header>
    <soapenv:Body>
    <sil1:AddContactToProgram>
    <sil1:PROGRAM_ID>129832</sil1:PROGRAM_ID>
    <sil1:CONTACT_ID>129832</sil1:CONTACT_ID>
    </sil1:AddContactToProgram>
    </soapenv:Body>
    </soapenv:Envelope> 
     
    Response  <RESULT>   
    Elements  SUCCESS  True if successful. 
    Example¬† <envelope:Envelope xmlns:envelope=”http://schemas.xmlsoap.org/soap/envelope/”>
    <envelope:Header/>
    <envelope:Body xmlns=”SilverpopApi:EngageService.ListMgmt.UserActions”>
    <RESULT>
    <SUCCESS>true</SUCCESS>
    </RESULT>
    </envelope:Body>
    </envelope:Envelope> 
     

Join The Discussion

Your email address will not be published. Required fields are marked *