Skip to main content

CustomerInviteTeamMemberInput

Invites a person to the customer's team.

input CustomerInviteTeamMemberInput {
approverBranchAddressIds: [ID!]
assignedAddressIds: [ID!]
customerApproverScope: String
department: String
email: String!
firstName: String
lastName: String
orderLimit: Float
phone: String
role: String!
title: String
whatsapp: String
}

Fields​

CustomerInviteTeamMemberInput.approverBranchAddressIds ● [ID!] list scalar​

granted branch address ids (required ≥1 when scope = BRANCH).

CustomerInviteTeamMemberInput.assignedAddressIds ● [ID!] list scalar​

Addresses this teammate may order to, chosen at INVITE time. Omit or [] leaves them unrestricted (the whole account address book) — it does NOT lock them out. Applied only to a genuinely new invite; the uniform anti-enumeration response assigns nothing.

CustomerInviteTeamMemberInput.customerApproverScope ● String scalar​

approver scope — COMPANY | BRANCH (default COMPANY).

CustomerInviteTeamMemberInput.department ● String scalar​

The person's department.

CustomerInviteTeamMemberInput.email ● String! non-null scalar​

Email address.

CustomerInviteTeamMemberInput.firstName ● String scalar​

The person's first name.

CustomerInviteTeamMemberInput.lastName ● String scalar​

The person's last name.

CustomerInviteTeamMemberInput.orderLimit ● Float scalar​

Per-buyer order-value ceiling (null = no limit).

CustomerInviteTeamMemberInput.phone ● String scalar​

Phone number.

CustomerInviteTeamMemberInput.role ● String! non-null scalar​

CUSTOMER_ADMIN | CUSTOMER_BUYER | CUSTOMER_VIEWER.

CustomerInviteTeamMemberInput.title ● String scalar​

The person's job title.

CustomerInviteTeamMemberInput.whatsapp ● String scalar​

The person's WhatsApp number.

Member Of​

customerInviteTeamMember mutation