ProgramMembers
Query Program members for a program.
Table Specific Information
Select
Retrieve all Program Members for the specific ProgramId.
Note:
- When UseBulkAPI=true and ProgramId is not specified, it will fetch the first ProgramId. We can only use =, IN operator with ProgramID.
- When UseBulkAPI=false and ProgramId is not specified, it will fetch records for all the ProgramId. We can specify the =, IN, >, <, <=, >= operator with ProgramID.
SELECT * FROM ProgramMembers WHERE ProgramId = 1102 SELECT * FROM ProgramMembers WHERE ProgramId = '1044' AND LeadId IN ('1789','1789','1790','1791','1792') SELECT * FROM ProgramMembers WHERE ProgramId = '1001' AND LeadId = '4' SELECT * FROM ProgramMembers WHERE ProgramId IN (1102, 1103, 1104) SELECT * FROM ProgramMembers WHERE LeadId IN ('1789','1790','1791','1792') AND reachedSuccess IN (false,true) SELECT * FROM ProgramMembers WHERE reachedSuccess IN (false,true) AND LeadId = '1789'
Insert
To create a new Program Member, specify at least the LeadId, StatusName and ProgramId column.This operation is only supported when UseBulkApi=false.
INSERT INTO ProgramMembers (LeadId,StatusName,ProgramId) VALUES (4,'member','1001')
Update
Fields WebinarURL and RegistrationCode can be updated. To update any Program Member, specify at least the LeadId, ProgramId column.This operation is only supported when UseBulkApi=false.
UPDATE ProgramMembers SET WebinarURL = 'www.testURL.com',RegistrationCode = 'dcff5f12-a7c7-11eb-bcbc-0242ac130001' WHERE LeadId = '4' AND ProgramId = '1001'
Delete
To delete a Program member you must specify the LeadId and ProgramId field.This operation is only supported when UseBulkApi=false.
DELETE FROM ProgramMembers WHERE LeadId = '4' AND ProgramId = '1001'
Columns
Name | Type | ReadOnly | Filterable | Description |
Id | Integer | True |
The Id of the Program Member | |
AcquiredBy | Boolean | False |
Indicates this program was responsible for creating the lead record | |
AttendanceLikelihood | Integer | False |
The likelihood of the attendance at the individual level | |
LeadId [KEY] | Integer | False | True |
The Id of the Lead |
MemberDate | Datetime | False |
The date of the membership | |
NurtureProgramId | String | True |
The Id of the Nurture Program | |
Program | String | False |
The Program with which the member is associated | |
ProgramId [KEY] | Integer | False | True |
The Id of the Program |
ProgramTypeId | String | True |
The Id of the Program Type | |
RegistrationCode | String | False |
The registration code | |
RegistrationLikelihood | String | False |
The registration likelihood | |
Status | String | False |
The Status of the Program Member | |
StatusId | String | True |
The Id of the Status of the Program Member | |
StatusReason | String | False |
The Reason of the Status of the Program Member | |
StatusName | String | False | True |
The name of the Status of the Program Member |
ReachedSuccess | Boolean | False | True |
Indicates when a person reaches the status that achieves that goal |
CreatedAt | Datetime | False |
The created date of the membership | |
IsExhausted | Boolean | False |
Indicates whether the membership is exhausted or not | |
MemberShipDate | Datetime | False |
The date of the membership | |
NurtureCadence | String | False |
The Nurture Program | |
ReachedSuccessDate | Datetime | False |
The date when a person reaches the status that achieves that goal | |
UpdatedAt | Datetime | False |
The updated date of the membership | |
Success | Boolean | False |
Indicates when a person reaches the status that achieves that goal | |
Track | String | False |
The track of the Program Member Activity | |
TrackName | String | False |
The name of the track | |
WaitlistPriority | Integer | False |
Indicates the program member waitlist priority | |
WebinarURL | String | False |
The Webinar URL |