Trendsic Platform Service

CustomerLinkCreateRequest

The following routes are available for this service:
POST,OPTIONS	/v1/customerlink

**CustomerLinkCreateRequest** Parameters:
Name	Parameter	Data Type	Required
ResourceType	body	string	No
ResourceUid	body	Guid	No
RecipientContactId	body	int?	No
RecipientEmail	body	string	No
RecipientPhone	body	string	No
DeliverEmail	body	bool	No
DeliverSms	body	bool	No
ExpiresInHours	body	int?	No
MaxViews	body	int?	No

**CustomerLinkCreateResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Link	form	CustomerLinkExtended	No
PortalUrl	form	string	No
DeliveryErrors	form	List<string>	No

**CustomerLinkExtended** Parameters:
Name	Parameter	Data Type	Required
RecipientDisplayName	form	string	No
RecipientType	form	string	No
Status	form	string	No

**CustomerLink** Parameters:
Name	Parameter	Data Type	Required
CustomerLinkId	form	int	No
CustomerLinkUID	form	Guid	No
TokenHash	form	string	No
ResourceType	form	string	No
ResourceUid	form	Guid	No
SensitivityTier	form	string	No
RequireOtp	form	bool	No
OtpChannel	form	string	No
DeliveryChannels	form	string	No
RecipientContactId	form	int?	No
RecipientEmail	form	string	No
RecipientPhone	form	string	No
SmsConsentSnapshot	form	bool	No
CreatedByUserId	form	Guid	No
CreatedByAgentId	form	int?	No
CreatedAtUtc	form	DateTime	No
ExpiresAtUtc	form	DateTime?	No
MaxViews	form	int?	No
ViewCount	form	int	No
RevokedAtUtc	form	DateTime?	No
RevokedByUserId	form	Guid?	No
TenantId	form	Guid	No

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 /v1/customerlink HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ResourceType: String,
	ResourceUid: 00000000000000000000000000000000,
	RecipientContactId: 0,
	RecipientEmail: String,
	RecipientPhone: String,
	DeliverEmail: False,
	DeliverSms: False,
	ExpiresInHours: 0,
	MaxViews: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Link: 
	{
		RecipientDisplayName: String,
		RecipientType: String,
		Status: String,
		CustomerLinkId: 0,
		CustomerLinkUID: 00000000000000000000000000000000,
		TokenHash: String,
		ResourceType: String,
		ResourceUid: 00000000000000000000000000000000,
		SensitivityTier: String,
		RequireOtp: False,
		OtpChannel: String,
		DeliveryChannels: String,
		RecipientContactId: 0,
		RecipientEmail: String,
		RecipientPhone: String,
		SmsConsentSnapshot: False,
		CreatedByUserId: 00000000000000000000000000000000,
		CreatedByAgentId: 0,
		CreatedAtUtc: 0001-01-01,
		ExpiresAtUtc: 0001-01-01,
		MaxViews: 0,
		ViewCount: 0,
		RevokedAtUtc: 0001-01-01,
		RevokedByUserId: 00000000000000000000000000000000,
		TenantId: 00000000000000000000000000000000
	},
	PortalUrl: String,
	DeliveryErrors: 
	[
		String
	]
}