Overview

Skill Level: Intermediate

Prerequisites

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

Note: The contact is not 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 that is 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 XML for AddContactToProgram

    Operation <AddContactToProgram>
    Elements PROGRAM_ID Unique ID of the program.
      CONTACT_ID Unique ID of the contact that is added to the program.
    Example
    <Envelope>
      <Body>
        <AddContactToProgram>
          <PROGRAM_ID>56753246</PROGRAM_ID>
          <CONTACT_ID>7657657</CONTACT_ID>
        </AddContactToProgram>
      </Body>
    </Envelope>
    
    Response <RESULT>
    Elements SUCCESS True if successful.
    Example
    <Envelope>
      <Body>
        <RESULT>
          <SUCCESS>TRUE</SUCCESS>
        </RESULT>
      </Body>
    </Envelope>
    

Join The Discussion

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