Trendsic Platform Service

FormInviteCreateRequest

The following routes are available for this service:
POST	/v1/forms/{FormUID}/invites

**FormInviteCreateRequest** Parameters:
Name	Parameter	Data Type	Required
FormUID	path	Guid	No
People	body	List<FormInvitePerson>	No
Preview	body	bool	No

**FormInvitePerson** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Email	form	string	No
Phone	form	string	No

**FormInvitesResponse** Parameters:
Name	Parameter	Data Type	Required
Invites	form	List<FormInviteView>	No
Created	form	List<FormInviteView>	No
Emails	form	int	No
Texts	form	int	No
Consequence	form	string	No
ResponseStatus	form	ResponseStatus	No

**FormInviteView** Parameters:
Name	Parameter	Data Type	Required
InviteUID	form	Guid	No
Name	form	string	No
Email	form	string	No
Phone	form	string	No
CreatedBy	form	string	No
CreatedAt	form	DateTime?	No
ExpiresAt	form	DateTime?	No
SentAt	form	DateTime?	No
LastSentAt	form	DateTime?	No
SendCount	form	int	No
OpenedAt	form	DateTime?	No
RevokedAt	form	DateTime?	No
Number	form	string	No
State	form	string	No
Link	form	string	No
Sends	form	List<FormFillReceiptLine>	No

**FormFillReceiptLine** Parameters:
Name	Parameter	Data Type	Required
Channel	form	string	No
To	form	string	No
Outcome	form	string	No

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/forms/{FormUID}/invites HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormInviteCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
  <People>
    <FormInvitePerson>
      <Email>String</Email>
      <Name>String</Name>
      <Phone>String</Phone>
    </FormInvitePerson>
  </People>
  <Preview>false</Preview>
</FormInviteCreateRequest>

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

<FormInvitesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Consequence>String</Consequence>
  <Created>
    <FormInviteView>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Email>String</Email>
      <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
      <InviteUID>00000000-0000-0000-0000-000000000000</InviteUID>
      <LastSentAt>0001-01-01T00:00:00</LastSentAt>
      <Link>String</Link>
      <Name>String</Name>
      <Number>String</Number>
      <OpenedAt>0001-01-01T00:00:00</OpenedAt>
      <Phone>String</Phone>
      <RevokedAt>0001-01-01T00:00:00</RevokedAt>
      <SendCount>0</SendCount>
      <Sends>
        <FormFillReceiptLine>
          <Channel>String</Channel>
          <Outcome>String</Outcome>
          <To>String</To>
        </FormFillReceiptLine>
      </Sends>
      <SentAt>0001-01-01T00:00:00</SentAt>
      <State>String</State>
    </FormInviteView>
  </Created>
  <Emails>0</Emails>
  <Invites>
    <FormInviteView>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Email>String</Email>
      <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
      <InviteUID>00000000-0000-0000-0000-000000000000</InviteUID>
      <LastSentAt>0001-01-01T00:00:00</LastSentAt>
      <Link>String</Link>
      <Name>String</Name>
      <Number>String</Number>
      <OpenedAt>0001-01-01T00:00:00</OpenedAt>
      <Phone>String</Phone>
      <RevokedAt>0001-01-01T00:00:00</RevokedAt>
      <SendCount>0</SendCount>
      <Sends>
        <FormFillReceiptLine>
          <Channel>String</Channel>
          <Outcome>String</Outcome>
          <To>String</To>
        </FormFillReceiptLine>
      </Sends>
      <SentAt>0001-01-01T00:00:00</SentAt>
      <State>String</State>
    </FormInviteView>
  </Invites>
  <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>
  <Texts>0</Texts>
</FormInvitesResponse>