Skip to main content
Anchor to ExternalAccountSetUserError

ExternalAccountSetUserError

object

An error that occurs during the execution of ExternalAccountSet.

Anchor to FieldsFields

Anchor to codecode
•ExternalAccountSetUserErrorCode

The error code.

Show enum values
Anchor to fieldfield
•[String!]

The path to the input field that caused the error.

Anchor to messagemessage
•String!
non-null

The error message.

Was this section helpful?

Anchor to MutationsMutations

Anchor to externalAccountSetexternalAccountSet
•mutation

Links a partner account to the shop's enrollment for the agentic channel that the calling app links. Every call sends the account's ID and name, and Shopify stores the name with the ID. Use null as the accountId to clear the link. An account that this mutation links replaces an account that Shopify matched automatically, and an automatic match never replaces it.

Show payload

Arguments

Anchor to accountIdaccountId
•String

The partner's account ID. Use null to clear the linked account.

Anchor to accountNameaccountName
•String

The partner account's name. Every call must include it. Use null when the account has no name. A link that's cleared has no name.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to DisplayableErrorDisplayableError
•interface
Was this section helpful?