Select integration external account

curl --request PATCH \
  --url https://api.interchange.io/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/select \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.interchange.io/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/select"

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.text)

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.interchange.io/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/select', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "connectionId": "<string>",
  "credentialId": "<string>",
  "externalAccountId": "<string>",
  "name": "<string>",
  "advertiser": "<string>",
  "currency": "<string>",
  "effectiveTimezone": "<string>",
  "status": "PENDING",
  "providerStatus": "active",
  "providerRawStatus": "<string>",
  "accountType": null,
  "amazonSponsoredAds": {
    "marketplaceId": "<string>",
    "validPaymentMethod": true,
    "countryCode": "<string>"
  },
  "parentExternalId": null,
  "parentName": null,
  "isDefault": true,
  "isSelected": true,
  "enhancedReporting": {
    "eligible": true,
    "enabled": true,
    "activatedAt": "2023-11-07T05:31:56Z",
    "disabledAt": "2023-11-07T05:31:56Z",
    "billingCustomerId": 4503599627370495,
    "canEnable": true
  },
  "archivedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "mappedAdvertisers": [],
  "campaignRollup": {
    "campaignsTracked": 4503599627370495,
    "campaignsActive": 4503599627370495,
    "trackedSpend": 1,
    "managedSpend": 1,
    "managedShare": 0.5,
    "currency": "<string>",
    "windowDays": 4503599627370495
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

PATCH

storefront-connections

{connectionId}

accounts

{accountId}

select

Select integration external account

curl --request PATCH \
  --url https://api.interchange.io/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/select \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.interchange.io/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/select"

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.text)

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.interchange.io/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/select', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "connectionId": "<string>",
  "credentialId": "<string>",
  "externalAccountId": "<string>",
  "name": "<string>",
  "advertiser": "<string>",
  "currency": "<string>",
  "effectiveTimezone": "<string>",
  "status": "PENDING",
  "providerStatus": "active",
  "providerRawStatus": "<string>",
  "accountType": null,
  "amazonSponsoredAds": {
    "marketplaceId": "<string>",
    "validPaymentMethod": true,
    "countryCode": "<string>"
  },
  "parentExternalId": null,
  "parentName": null,
  "isDefault": true,
  "isSelected": true,
  "enhancedReporting": {
    "eligible": true,
    "enabled": true,
    "activatedAt": "2023-11-07T05:31:56Z",
    "disabledAt": "2023-11-07T05:31:56Z",
    "billingCustomerId": 4503599627370495,
    "canEnable": true
  },
  "archivedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "mappedAdvertisers": [],
  "campaignRollup": {
    "campaignsTracked": 4503599627370495,
    "campaignsActive": 4503599627370495,
    "trackedSpend": 1,
    "managedSpend": 1,
    "managedShare": 0.5,
    "currency": "<string>",
    "windowDays": 4503599627370495
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

{
  "data": null,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

API key or access token

Path Parameters

connectionId

integer<int64>

required

Storefront connection ID

accountId

integer<int64>

required

Storefront connection account ID

Response

Select integration external account

Provider account discovered for a buyer storefront connection.

string

required

connectionId

string

required

credentialId

string | null

required

externalAccountId

string

required

name

string | null

required

advertiser

string | null

required

Provider-reported advertiser identity after safe normalization.

currency

string | null

required

Authoritative provider account currency when the adapter reports it.

Pattern: ^[A-Z]{3}$

effectiveTimezone

string | null

required

Seller-effective IANA reporting timezone for this account. Reporting calendar boundaries for this account use this value; null when the provider has not reported one.

status

enum<string>

required

Available options:

PENDING,

ACTIVE,

DISABLED,

ERROR

providerStatus

enum<string> | null

required

Normalized AdCP account status reported by the provider adapter.

Available options:

active,

pending_approval,

payment_required,

rejected,

suspended,

closed

providerRawStatus

required

Safe provider-native status value retained for diagnosis, when reported.

accountType

string | null

required

Account hierarchy classification from the platform adapter: 'advertiser' (buyable leaf), 'organization' (manager container — never mappable or buyable), or a platform subtype such as 'sponsored_ads', 'dsp', or 'publisher_identity'. Null for legacy rows, treated as a leaf account.

amazonSponsoredAds

object | null

required

Strict, allowlisted Amazon Ads profile projection. Present only for a sponsored_ads account with a valid marketplace ID and payment-method signal; null for every other account or malformed provider metadata.

Show child attributes

parentExternalId

string | null

required

External id of the parent account, when known: a manager container (Meta Business Manager, Google MCC, Snap Organization, …), or where the platform has no manager surface, the owning entity (LinkedIn organization; the owning advertiser account for TikTok channel identities). Id format is platform-native and may differ from the account's own id format.

parentName

string | null

required

Display name of the parent account, when known.

isDefault

boolean

required

isSelected

boolean

required

enhancedReporting

object

required

Account-scoped Enhanced Reporting control for any connected account. It is billed at the published per-account rate.

Show child attributes

archivedAt

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

mappedAdvertisers

object[]

required

Advertisers this external account is mapped to for buyer workflows.

Show child attributes

campaignRollup

object

Directed-campaign rollup for this account. Present only when the account has live campaign mirrors and a resolvable currency; omitted otherwise.

Show child attributes

Start building

Core Concepts

Buyer operations

Seller operations

Cross-Cutting Reference

Buyer API reference

Seller API reference

Release Notes

Select integration external account

Authorizations

Path Parameters

Response