Trendsic Platform Service

<back to all web services

FormInviteCreateRequest

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

export class FormFillReceiptLine
{
    public Channel: string;
    public To: string;
    public Outcome: string;

    public constructor(init?: Partial<FormFillReceiptLine>) { (Object as any).assign(this, init); }
}

export class FormInviteView
{
    public InviteUID: string;
    public Name: string;
    public Email: string;
    public Phone: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public ExpiresAt?: string;
    public SentAt?: string;
    public LastSentAt?: string;
    public SendCount: number;
    public OpenedAt?: string;
    public RevokedAt?: string;
    public Number: string;
    public State: string;
    public Link: string;
    public Sends: FormFillReceiptLine[] = [];

    public constructor(init?: Partial<FormInviteView>) { (Object as any).assign(this, init); }
}

export class FormInvitesResponse
{
    public Invites: FormInviteView[] = [];
    public Created: FormInviteView[] = [];
    public Emails: number;
    public Texts: number;
    public Consequence: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FormInvitesResponse>) { (Object as any).assign(this, init); }
}

export class FormInvitePerson
{
    public Name: string;
    public Email: string;
    public Phone: string;

    public constructor(init?: Partial<FormInvitePerson>) { (Object as any).assign(this, init); }
}

export class FormInviteCreateRequest
{
    public FormUID: string;
    public People: FormInvitePerson[] = [];
    public Preview: boolean;

    public constructor(init?: Partial<FormInviteCreateRequest>) { (Object as any).assign(this, init); }
}

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

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}