Skip to main content

InviteCustomerUserInput

Invites a person to a customer account.

input InviteCustomerUserInput {
  approvesOrders: Boolean
  assignedAddressIds: [ID!]
  email: String!
  firstName: String
  lastName: String
  orderLimit: Float
  partnerId: ID!
  role: String
}

Fields​

InviteCustomerUserInput.approvesOrders ● Boolean scalar​

May approve teammates' over-limit order requests. Forced true for CUSTOMER_ADMIN.

InviteCustomerUserInput.assignedAddressIds ● [ID!] list scalar​

Addresses to assign to the new login. Meaningful only for CUSTOMER_BUYER / CUSTOMER_VIEWER — omit or [] leaves them with NO addresses until the owner assigns some (resolveAddressScope). A CUSTOMER_ADMIN invite is always unrestricted regardless of this field. Applied only to a genuinely new invite; an email already owned elsewhere returns the uniform anti-enumeration shape and assigns nothing.

InviteCustomerUserInput.email ● String! non-null scalar​

Email address.

InviteCustomerUserInput.firstName ● String scalar​

The person's first name.

InviteCustomerUserInput.lastName ● String scalar​

The person's last name.

InviteCustomerUserInput.orderLimit ● Float scalar​

Per-buyer order-value ceiling in the org base currency; null/omitted = no limit.

InviteCustomerUserInput.partnerId ● ID! non-null scalar​

The ID of the partner.

InviteCustomerUserInput.role ● String scalar​

CUSTOMER_ADMIN | CUSTOMER_BUYER | CUSTOMER_VIEWER (default CUSTOMER_BUYER).

Member Of​

inviteCustomerUser mutation