Map external account to advertiser

curl --request POST \
  --url https://api.interchange.io/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/advertiser \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "advertiserId": "<string>"
}
'

import requests

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

payload = { "advertiserId": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({advertiserId: '<string>'})
};

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

{
  "linkId": "42",
  "accountId": "acc_acme_pinnacle",
  "sources": [
    {
      "storefrontId": 0,
      "storefrontName": "<string>",
      "sourceId": "<string>",
      "sourceName": "<string>"
    }
  ],
  "advertiserId": "12345",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-20T14:45:00Z",
  "credentialId": "42",
  "name": "Acme c/o Pinnacle",
  "advertiser": "Acme Corp",
  "billingProxy": "Pinnacle Media",
  "house": "acme-corp.com",
  "billing": "advertiser",
  "unreachableAt": "2025-01-22T09:00:00Z"
}

{
  "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": {}
  }
}

POST

storefront-connections

{connectionId}

accounts

{accountId}

advertiser

Map external account to advertiser

curl --request POST \
  --url https://api.interchange.io/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/advertiser \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "advertiserId": "<string>"
}
'

import requests

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

payload = { "advertiserId": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({advertiserId: '<string>'})
};

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

{
  "linkId": "42",
  "accountId": "acc_acme_pinnacle",
  "sources": [
    {
      "storefrontId": 0,
      "storefrontName": "<string>",
      "sourceId": "<string>",
      "sourceName": "<string>"
    }
  ],
  "advertiserId": "12345",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-20T14:45:00Z",
  "credentialId": "42",
  "name": "Acme c/o Pinnacle",
  "advertiser": "Acme Corp",
  "billingProxy": "Pinnacle Media",
  "house": "acme-corp.com",
  "billing": "advertiser",
  "unreachableAt": "2025-01-22T09:00:00Z"
}

{
  "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

Body

application/json

advertiserId

string

required

Numeric advertiser ID to map this provider account to

Pattern: ^\d+$

sourceId

string

Optional adapter provider ID for compatibility. Official adapter mappings derive the canonical provider ID from connectionId; when supplied, use the canonical value returned by the mappings list (for example, meta). Historical adapter/platform aliases remain accepted.

Minimum string length: 1

Response

Map external account to advertiser

Linked account resource on a partner platform

linkId

string

required

Unique identifier for the advertiser-account link

Example:

"42"

accountId

string

required

Partner account identifier

Example:

"acc_acme_pinnacle"

sources

object[]

required

Storefront sources that surface this account to the buyer. A single linked account may be reachable through multiple sources when the underlying agent is shared across storefronts. Empty when the underlying agent is no longer linked to any active storefront source.

Show child attributes

advertiserId

string

required

Advertiser that owns this account link

Example:

"12345"

status

enum<string>

required

Current account status

Available options:

active,

pending_approval,

payment_required,

suspended,

closed,

unreachable

createdAt

string<date-time>

required

When the account was created (ISO 8601)

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))$

Example:

"2025-01-15T10:30:00Z"

updatedAt

string<date-time>

required

When the account was last updated (ISO 8601)

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))$

Example:

"2025-01-20T14:45:00Z"

credentialId

string | null

Credential row that owns this linked account. Include this value when updating linked accounts so duplicate account IDs across mapped connections remain unambiguous.

Example:

"42"

name

string | null

Human-readable account name from the partner

Example:

"Acme c/o Pinnacle"

advertiser

string | null

Advertiser name as recorded by the partner platform

Example:

"Acme Corp"

billingProxy

string | null

Billing proxy entity (e.g. agency buying on behalf of advertiser)

Example:

"Pinnacle Media"

house

string | null

Domain or house identifier for the account

Example:

"acme-corp.com"

billing

string | null

Billing arrangement type

Example:

"advertiser"

unreachableAt

string<date-time> | null

When set, the mapping is preserved but its platform account is no longer reachable through any active connection — the connection that surfaced it was unlinked. Relink the provider (or re-map the account) to restore it. Unreachable mappings never resolve at buy time.

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))$

Example:

"2025-01-22T09:00:00Z"

Select integration external account Subscribe a directed-campaign account (alpha)

⌘I