Enables scripted content fragments to access Group Contact Requests
Methods
Approve
Approves a group contact request
Usage
#set($additionalInfoResponse = $core_v2_groupContactRequest.Approve($groupId, $contactRequestId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
contactRequestId | int | Contact Request Id | Required |
Return Type
Create
Creates a new group contact request
Usage
#set($groupContactRequestResponse = $core_v2_groupContactRequest.Create($groupId, $emailAddress))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
emailAddress | string | Email Address | Required |
Return Type
Create
Creates a new group contact request
Usage
#set($groupContactRequestResponse = $core_v2_groupContactRequest.Create($groupId, $emailAddress, "%{Body = $bodyArg, Name = $nameArg, Subject = $subjectArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
emailAddress | string | Email Address | Required | ||
Body | string | Body | Optional | ||
Name | string | Name | Optional | ||
Subject | string | Subject | Optional |
Return Type
Delete
Deletes a group contact request
Usage
#set($additionalInfoResponse = $core_v2_groupContactRequest.Delete($groupId, $contactRequestId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
contactRequestId | int | Contact Request Id | Required |
Return Type
Get
Gets a group contact request
Usage
#set($groupContactRequestResponse = $core_v2_groupContactRequest.Get($groupId, $contactRequestId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
contactRequestId | int | Contact Request Id | Required |
Return Type
List
List contact requests
Usage
#set($pagedListResponse = $core_v2_groupContactRequest.List($groupId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required |
Return Type
PagedList<GroupContactRequest>
List
List contact requests
Usage
#set($pagedListResponse = $core_v2_groupContactRequest.List($groupId, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 |