setTeamMemberAddresses

Requires a customer (portal or buyer app) session.

Set the FULL list of addresses assigned to one team member (account owner only). Declarative: send the desired end state and it reconciles. An EMPTY list clears every assignment, which returns that member to seeing the whole account address book — a member with no assignments is unrestricted, not locked out. Returns the assigned ids.

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 SetTeamMemberAddresses($addressIds: [ID!]!, $userId: ID!) {
  setTeamMemberAddresses(addressIds: $addressIds, userId: $userId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetTeamMemberAddresses($addressIds: [ID!]!, $userId: ID!) {\n  setTeamMemberAddresses(addressIds: $addressIds, userId: $userId)\n}",
  "variables": {
    "addressIds": [
      "id"
    ],
    "userId": "id"
  }
}
EOF

Variables:

{
  "addressIds": [
    "id"
  ],
  "userId": "id"
}

Response:

{
  "data": {
    "setTeamMemberAddresses": [
      "id"
    ]
  }
}

setTeamMemberAddresses(
  addressIds: [ID!]!
  userId: ID!
): [ID!]!

Arguments

setTeamMemberAddresses.addressIds ● [ID!]! non-null scalar

The IDs of the addresses.

setTeamMemberAddresses.userId ● ID! non-null scalar

The ID of the user.

Type

ID scalar

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.