Trendsic Platform Service

<back to all web services

CustomerLinkCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/customerlink
"use strict";
export class CustomerLink {
    /** @param {{CustomerLinkId?:number,CustomerLinkUID?:string,TokenHash?:string,ResourceType?:string,ResourceUid?:string,SensitivityTier?:string,RequireOtp?:boolean,OtpChannel?:string,DeliveryChannels?:string,RecipientContactId?:number,RecipientEmail?:string,RecipientPhone?:string,SmsConsentSnapshot?:boolean,CreatedByUserId?:string,CreatedByAgentId?:number,CreatedAtUtc?:string,ExpiresAtUtc?:string,MaxViews?:number,ViewCount?:number,RevokedAtUtc?:string,RevokedByUserId?:string,TenantId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CustomerLinkId;
    /** @type {string} */
    CustomerLinkUID;
    /** @type {string} */
    TokenHash;
    /** @type {string} */
    ResourceType;
    /** @type {string} */
    ResourceUid;
    /** @type {string} */
    SensitivityTier;
    /** @type {boolean} */
    RequireOtp;
    /** @type {string} */
    OtpChannel;
    /** @type {string} */
    DeliveryChannels;
    /** @type {?number} */
    RecipientContactId;
    /** @type {string} */
    RecipientEmail;
    /** @type {string} */
    RecipientPhone;
    /** @type {boolean} */
    SmsConsentSnapshot;
    /** @type {string} */
    CreatedByUserId;
    /** @type {?number} */
    CreatedByAgentId;
    /** @type {string} */
    CreatedAtUtc;
    /** @type {?string} */
    ExpiresAtUtc;
    /** @type {?number} */
    MaxViews;
    /** @type {number} */
    ViewCount;
    /** @type {?string} */
    RevokedAtUtc;
    /** @type {?string} */
    RevokedByUserId;
    /** @type {string} */
    TenantId;
}
export class CustomerLinkExtended extends CustomerLink {
    /** @param {{RecipientDisplayName?:string,RecipientType?:string,Status?:string,CustomerLinkId?:number,CustomerLinkUID?:string,TokenHash?:string,ResourceType?:string,ResourceUid?:string,SensitivityTier?:string,RequireOtp?:boolean,OtpChannel?:string,DeliveryChannels?:string,RecipientContactId?:number,RecipientEmail?:string,RecipientPhone?:string,SmsConsentSnapshot?:boolean,CreatedByUserId?:string,CreatedByAgentId?:number,CreatedAtUtc?:string,ExpiresAtUtc?:string,MaxViews?:number,ViewCount?:number,RevokedAtUtc?:string,RevokedByUserId?:string,TenantId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    RecipientDisplayName;
    /** @type {string} */
    RecipientType;
    /** @type {string} */
    Status;
}
export class CustomerLinkCreateResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Link?:CustomerLinkExtended,PortalUrl?:string,DeliveryErrors?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CustomerLinkExtended} */
    Link;
    /** @type {string} */
    PortalUrl;
    /** @type {string[]} */
    DeliveryErrors = [];
}
export class CustomerLinkCreateRequest {
    /** @param {{ResourceType?:string,ResourceUid?:string,RecipientContactId?:number,RecipientEmail?:string,RecipientPhone?:string,DeliverEmail?:boolean,DeliverSms?:boolean,ExpiresInHours?:number,MaxViews?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ResourceType;
    /** @type {string} */
    ResourceUid;
    /** @type {?number} */
    RecipientContactId;
    /** @type {string} */
    RecipientEmail;
    /** @type {string} */
    RecipientPhone;
    /** @type {boolean} */
    DeliverEmail;
    /** @type {boolean} */
    DeliverSms;
    /** @type {?number} */
    ExpiresInHours;
    /** @type {?number} */
    MaxViews;
}

JavaScript CustomerLinkCreateRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerLinkCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DeliverEmail>false</DeliverEmail>
  <DeliverSms>false</DeliverSms>
  <ExpiresInHours>0</ExpiresInHours>
  <MaxViews>0</MaxViews>
  <RecipientContactId>0</RecipientContactId>
  <RecipientEmail>String</RecipientEmail>
  <RecipientPhone>String</RecipientPhone>
  <ResourceType>String</ResourceType>
  <ResourceUid>00000000-0000-0000-0000-000000000000</ResourceUid>
</CustomerLinkCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerLinkCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DeliveryErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryErrors>
  <Link>
    <CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
    <CreatedByAgentId>0</CreatedByAgentId>
    <CreatedByUserId>00000000-0000-0000-0000-000000000000</CreatedByUserId>
    <CustomerLinkId>0</CustomerLinkId>
    <CustomerLinkUID>00000000-0000-0000-0000-000000000000</CustomerLinkUID>
    <DeliveryChannels>String</DeliveryChannels>
    <ExpiresAtUtc>0001-01-01T00:00:00</ExpiresAtUtc>
    <MaxViews>0</MaxViews>
    <OtpChannel>String</OtpChannel>
    <RecipientContactId>0</RecipientContactId>
    <RecipientEmail>String</RecipientEmail>
    <RecipientPhone>String</RecipientPhone>
    <RequireOtp>false</RequireOtp>
    <ResourceType>String</ResourceType>
    <ResourceUid>00000000-0000-0000-0000-000000000000</ResourceUid>
    <RevokedAtUtc>0001-01-01T00:00:00</RevokedAtUtc>
    <RevokedByUserId>00000000-0000-0000-0000-000000000000</RevokedByUserId>
    <SensitivityTier>String</SensitivityTier>
    <SmsConsentSnapshot>false</SmsConsentSnapshot>
    <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
    <TokenHash>String</TokenHash>
    <ViewCount>0</ViewCount>
    <RecipientDisplayName>String</RecipientDisplayName>
    <RecipientType>String</RecipientType>
    <Status>String</Status>
  </Link>
  <PortalUrl>String</PortalUrl>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CustomerLinkCreateResponse>