Adding Custom Metadata to a Connected Account

You can add or change custom metadata for a connected account.

You can use custom metadata to store a custom payload or object, tailored to the specific needs of your app. For example, this feature is useful for tracking customer information, internal user IDs, or other internal resources for a connected account. Storing custom metadata in a Seam connected_account object enables you to look up an internal resource from directly within your Seam workspace. Then, you can filter connected accounts by the desired metadata.

You can also use unique resource keys as an easy way to link your resources to Seam resources. For details, see Mapping Your Resources to Seam Resources.

If the associated Connect Webview contains custom metadata, Seam transfers this custom metadata as the initial value for this property. However, you can use the Update Connected Account method with the optional custom_metadata property to change or add custom metadata for the connected account. This property accepts up to 50 JSON key:value pairs.

JavaScript

Request:

const connectedAccountUpdate = await seam.connectedAccounts.update({
  connected_account_id: "6e1cad57-b244-40ca-b4f3-30a46c8000d4",
  custom_metadata: {
    "internal_account_id": "user-1"
  }
})

console.log(connectedAccountUpdate)

Response:

{ ok: true }

cURL

Python

Ruby

PHP

C#