Cdn API - CPG Source

<back to all web services

EmailRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/EmailRequest
EmailRequest Parameters:
NameParameterData TypeRequiredDescription
IdbodylongNo
EmailAddressbodystringNo
ActivebodyboolNo
LastModbodyDateTimeNo
LastModBybodystringNo
LabelbodystringNo
IsPrimarybodyboolNo
IsMailChimpUploadedbodyboolNo
CustomerIDbodylongNo
SubscribeToListbodyboolNo
IsUspsValidbodyboolNo
IsDealerDirectorybodyboolNo
IsCdnxbodyboolNo
OrganizationIdbodylongNo
EmailResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<EmailDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
EmailDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
EmailAddressformstringNo
LabelformstringNo
IsPrimaryformboolNo
IsMailChimpUploadedformboolNo
IsOnMailChimpListformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
CustomerIDformlongNo
OrganizationIdformlongNo

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 /EmailRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	EmailAddress: String,
	Active: False,
	LastMod: 0001-01-01,
	LastModBy: String,
	Label: String,
	IsPrimary: False,
	IsMailChimpUploaded: False,
	CustomerID: 0,
	SubscribeToList: False,
	IsUspsValid: False,
	IsDealerDirectory: False,
	IsCdnx: False,
	OrganizationId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String,
			EmailAddress: String,
			Label: String,
			IsPrimary: False,
			IsMailChimpUploaded: False,
			IsOnMailChimpList: False,
			IsDealerDirectory: False,
			IsCdnx: False,
			CustomerID: 0,
			OrganizationId: 0
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}