customerInviteTeamMember

Requires a customer (portal or buyer app) session.

Invite a teammate (CUSTOMER_ADMIN only). Roles reuse CUSTOMER_* UserRole members. screen 16.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CustomerInviteTeamMember($input: CustomerInviteTeamMemberInput!) {
  customerInviteTeamMember(input: $input) {
    title
    firstName
    lastName
    status
    approvesOrders
    assignedAddressIds
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CustomerInviteTeamMember($input: CustomerInviteTeamMemberInput!) {\n  customerInviteTeamMember(input: $input) {\n    title\n    firstName\n    lastName\n    status\n    approvesOrders\n    assignedAddressIds\n  }\n}",
  "variables": {
    "input": {
      "email": "string",
      "role": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "email": "string",
    "role": "string"
  }
}

Response:

{
  "data": {
    "customerInviteTeamMember": {
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "status": "string",
      "approvesOrders": true,
      "assignedAddressIds": [
        "id"
      ]
    }
  }
}

customerInviteTeamMember(
  input: CustomerInviteTeamMemberInput!
): CustomerTeamMember!

Arguments

customerInviteTeamMember.input ● CustomerInviteTeamMemberInput! non-null input

The details of the customer invite team member request.

Type

CustomerTeamMember object

One buyer-side team member (a CUSTOMER-userType User under this partner).