core_v2_groupContactRequest Script API

Ben Tiedt — Wed, 20 Nov 2019 14:52:13 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:52:13

Enables scripted content fragments to access Group Contact Requests

Approve
Create
Delete
Get
List

Methods

Approve

Approves a group contact request

Velocity

#set($additionalInfoResponse = $core_v2_groupContactRequest.Approve($groupId, $contactRequestId))

JavaScript

var additionalInfoResponse = core_v2_groupContactRequest.Approve(groupId, contactRequestId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
contactRequestId	`Int32`	Contact Request Id	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Create

Create Overload 1

Creates a new group contact request

Velocity

#set($groupContactRequestResponse = $core_v2_groupContactRequest.Create($groupId, $emailAddress))

JavaScript

var groupContactRequestResponse = core_v2_groupContactRequest.Create(groupId, emailAddress);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
emailAddress	`String`	Email Address	Required

Create Overload 2

Creates a new group contact request

Velocity

#set($groupContactRequestResponse = $core_v2_groupContactRequest.Create($groupId, $emailAddress, "%{ Body = $bodyArg, Name = $nameArg, Subject = $subjectArg }"))

JavaScript

var groupContactRequestResponse = core_v2_groupContactRequest.Create(groupId, emailAddress, { Body: bodyArg, Name: nameArg, Subject: subjectArg });

Parameters

Name	Type	Description	Required
groupId	`Int32`	Group Id	Required
emailAddress	`String`	Email Address	Required
Body	`String`	Body	Optional
Name	`String`	Name	Optional
Subject	`String`	Subject	Optional

Returns

[[GroupContactRequest Script API Type|GroupContactRequest]]

Delete

Deletes a group contact request

Velocity

#set($additionalInfoResponse = $core_v2_groupContactRequest.Delete($groupId, $contactRequestId))

JavaScript

var additionalInfoResponse = core_v2_groupContactRequest.Delete(groupId, contactRequestId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
contactRequestId	`Int32`	Contact Request Id	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Gets a group contact request

Velocity

#set($groupContactRequestResponse = $core_v2_groupContactRequest.Get($groupId, $contactRequestId))

JavaScript

var groupContactRequestResponse = core_v2_groupContactRequest.Get(groupId, contactRequestId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
contactRequestId	`Int32`	Contact Request Id	Required

Returns

[[GroupContactRequest Script API Type|GroupContactRequest]]

List

List Overload 1

List contact requests

Velocity

#set($pagedListResponse = $core_v2_groupContactRequest.List($groupId))

JavaScript

var pagedListResponse = core_v2_groupContactRequest.List(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

List Overload 2

List contact requests

Velocity

#set($pagedListResponse = $core_v2_groupContactRequest.List($groupId, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_groupContactRequest.List(groupId, { PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

Name	Type	Description	Required	Default
groupId	`Int32`	Group Id	Required
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20

Returns

[[PagedList Script API Type|PagedList]] of [[GroupContactRequest Script API Type|GroupContactRequest]]