digitaluapi

<back to all web services

PartnerInvitesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/partner_invites
PartnerInvitesAdd Parameters:
NameParameterData TypeRequiredDescription
TemplateTextbodystringNo
InviteGuidbodyGuidYes
PartnerAppUserIdbodyintYes
DateCreatedbodyDateTimeOffsetYes
DateSentbodyDateTimeOffset?No
RecipientsbodystringYes
ReferencebodystringNo
RetryCountbodyintYes
StatusCodesIdbodylongYes
PartnerInvitesAddResponse Parameters:
NameParameterData TypeRequiredDescription
TemplateTextformstringNo
InviteGuidformGuidNo
PartnerAppUserIdformintNo
DateCreatedformDateTimeOffsetNo
DateSentformDateTimeOffset?No
RecipientsformstringNo
ReferenceformstringNo
RetryCountformintNo
StatusCodesIdformlongNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /partner_invites HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TemplateText: String,
	InviteGuid: 00000000000000000000000000000000,
	PartnerAppUserId: 0,
	DateCreated: 0001-01-01T00:00:00.0000000+00:00,
	DateSent: 0001-01-01T00:00:00.0000000+00:00,
	Recipients: String,
	Reference: String,
	RetryCount: 0,
	StatusCodesId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TemplateText: String,
	InviteGuid: 00000000000000000000000000000000,
	PartnerAppUserId: 0,
	DateCreated: 0001-01-01T00:00:00.0000000+00:00,
	DateSent: 0001-01-01T00:00:00.0000000+00:00,
	Recipients: String,
	Reference: String,
	RetryCount: 0,
	StatusCodesId: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}