Trendsic Platform Service

<back to all web services

CustomerLinkCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/customerlink
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CustomerLink
    {
        public virtual int CustomerLinkId { get; set; }
        public virtual Guid CustomerLinkUID { get; set; }
        public virtual string TokenHash { get; set; }
        public virtual string ResourceType { get; set; }
        public virtual Guid ResourceUid { get; set; }
        public virtual string SensitivityTier { get; set; }
        public virtual bool RequireOtp { get; set; }
        public virtual string OtpChannel { get; set; }
        public virtual string DeliveryChannels { get; set; }
        public virtual int? RecipientContactId { get; set; }
        public virtual string RecipientEmail { get; set; }
        public virtual string RecipientPhone { get; set; }
        public virtual bool SmsConsentSnapshot { get; set; }
        public virtual Guid CreatedByUserId { get; set; }
        public virtual int? CreatedByAgentId { get; set; }
        public virtual DateTime CreatedAtUtc { get; set; }
        public virtual DateTime? ExpiresAtUtc { get; set; }
        public virtual int? MaxViews { get; set; }
        public virtual int ViewCount { get; set; }
        public virtual DateTime? RevokedAtUtc { get; set; }
        public virtual Guid? RevokedByUserId { get; set; }
        public virtual Guid TenantId { get; set; }
    }

    public partial class CustomerLinkCreateRequest
    {
        public virtual string ResourceType { get; set; }
        public virtual Guid ResourceUid { get; set; }
        public virtual int? RecipientContactId { get; set; }
        public virtual string RecipientEmail { get; set; }
        public virtual string RecipientPhone { get; set; }
        public virtual bool DeliverEmail { get; set; }
        public virtual bool DeliverSms { get; set; }
        public virtual int? ExpiresInHours { get; set; }
        public virtual int? MaxViews { get; set; }
    }

    public partial class CustomerLinkCreateResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual CustomerLinkExtended Link { get; set; }
        public virtual string PortalUrl { get; set; }
        public virtual List<string> DeliveryErrors { get; set; } = [];
    }

    public partial class CustomerLinkExtended
        : CustomerLink
    {
        public virtual string RecipientDisplayName { get; set; }
        public virtual string RecipientType { get; set; }
        public virtual string Status { get; set; }
    }

}

C# CustomerLinkCreateRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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-01T00:00:00.0000000","ExpiresAtUtc":"0001-01-01T00:00:00.0000000","MaxViews":0,"ViewCount":0,"RevokedAtUtc":"0001-01-01T00:00:00.0000000","RevokedByUserId":"00000000000000000000000000000000","TenantId":"00000000000000000000000000000000"},"PortalUrl":"String","DeliveryErrors":["String"]}