Skip to main content

SendInvitationEmailInput

No description

input SendInvitationEmailInput {
  accord: SendInvitationEmailAccordInput
  senderId: String!
  receiverId: String!
  receiverEmail: String!
  receiverRole: String!
  workspaceId: String!
  text: String
  subject: String
  title: String
  subtitle: String
  footer: String
  expiredText: String
}

Fields​

SendInvitationEmailInput.accord ● SendInvitationEmailAccordInput input​

When set, sends an accord-scoped invitation; otherwise a generic workspace invite is sent.

SendInvitationEmailInput.senderId ● String! non-null scalar​

Account id of the sender.

SendInvitationEmailInput.receiverId ● String! non-null scalar​

Account id of the recipient.

SendInvitationEmailInput.receiverEmail ● String! non-null scalar​

Email address of the recipient.

SendInvitationEmailInput.receiverRole ● String! non-null scalar​

Recipient's role; selects the email template (buyer vs. seller).

SendInvitationEmailInput.workspaceId ● String! non-null scalar​

Workspace the invitation is sent from.

SendInvitationEmailInput.text ● String scalar​

Optional custom body text for the invitation.

SendInvitationEmailInput.subject ● String scalar​

Optional custom subject line (generic workspace invite).

SendInvitationEmailInput.title ● String scalar​

Optional custom title (generic workspace invite).

SendInvitationEmailInput.subtitle ● String scalar​

Optional custom subtitle (generic workspace invite).

Optional custom footer (generic workspace invite).

SendInvitationEmailInput.expiredText ● String scalar​

Optional custom expired-link text (generic workspace invite).

Member Of​

sendInvitationEmail query ● sendSampleInvitationEmail query