Choose a version:

externalAccountSet

mutation

Requires Requires the write_external_accounts capability, which Shopify grants to approved apps. Merchants don't grant it, and apps don't request it as an access scope. The app must be the linking app of an agentic channel, and must call with its own installation token, not a delegate access token or a Direct API access token.

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.

Anchor to Arguments

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 ExternalAccountSetPayload returnsExternalAccountSetPayload returns

Anchor to externalAccountexternalAccount •AgenticExternalAccount: The partner account that's linked to the shop's enrollment for the channel.

Show fields
Anchor to userErrorsuserErrors •[ExternalAccountSetUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

externalAccountSet reference

Mutation Reference

mutation externalAccountSet($accountId: String, $accountName: String) {

externalAccountSet(accountId: $accountId, accountName: $accountName) {

externalAccount {

# AgenticExternalAccount fields

}

userErrors {

field

message

}

Input

{

"accountId": "<your-accountId>",

"accountName": "<your-accountName>"

}