Trendsic Platform Service

<back to all web services

FormInviteCreateRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/{FormUID}/invites
FormInviteCreateRequest Parameters:
NameParameterData TypeRequiredDescription
FormUIDpathGuidNo
PeoplebodyList<FormInvitePerson>No
PreviewbodyboolNo
FormInvitePerson Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EmailformstringNo
PhoneformstringNo
FormInvitesResponse Parameters:
NameParameterData TypeRequiredDescription
InvitesformList<FormInviteView>No
CreatedformList<FormInviteView>No
EmailsformintNo
TextsformintNo
ConsequenceformstringNo
ResponseStatusformResponseStatusNo
FormInviteView Parameters:
NameParameterData TypeRequiredDescription
InviteUIDformGuidNo
NameformstringNo
EmailformstringNo
PhoneformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
ExpiresAtformDateTime?No
SentAtformDateTime?No
LastSentAtformDateTime?No
SendCountformintNo
OpenedAtformDateTime?No
RevokedAtformDateTime?No
NumberformstringNo
StateformstringNo
LinkformstringNo
SendsformList<FormFillReceiptLine>No
FormFillReceiptLine Parameters:
NameParameterData TypeRequiredDescription
ChannelformstringNo
ToformstringNo
OutcomeformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"FormUID":"00000000000000000000000000000000","People":[{"Name":"String","Email":"String","Phone":"String"}],"Preview":false}

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

{"Invites":[{"InviteUID":"00000000000000000000000000000000","Name":"String","Email":"String","Phone":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","ExpiresAt":"0001-01-01T00:00:00.0000000","SentAt":"0001-01-01T00:00:00.0000000","LastSentAt":"0001-01-01T00:00:00.0000000","SendCount":0,"OpenedAt":"0001-01-01T00:00:00.0000000","RevokedAt":"0001-01-01T00:00:00.0000000","Number":"String","State":"String","Link":"String","Sends":[{"Channel":"String","To":"String","Outcome":"String"}]}],"Created":[{"InviteUID":"00000000000000000000000000000000","Name":"String","Email":"String","Phone":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","ExpiresAt":"0001-01-01T00:00:00.0000000","SentAt":"0001-01-01T00:00:00.0000000","LastSentAt":"0001-01-01T00:00:00.0000000","SendCount":0,"OpenedAt":"0001-01-01T00:00:00.0000000","RevokedAt":"0001-01-01T00:00:00.0000000","Number":"String","State":"String","Link":"String","Sends":[{"Channel":"String","To":"String","Outcome":"String"}]}],"Emails":0,"Texts":0,"Consequence":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}