Skip to main content
Anchor to ExternalAccountSetPayload

ExternalAccountSetPayload

payload

Return type for externalAccountSet mutation.

Anchor to FieldsFields

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?

Anchor to Mutations with this payloadMutations with this payload

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?