Create or dry-run a signal for an ad server source
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/esa/{esaId}/signals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"signalId": "<string>",
"name": "<string>",
"adapterConfig": {},
"description": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/esa/{esaId}/signals"
payload = {
"signalId": "<string>",
"name": "<string>",
"adapterConfig": {},
"description": "<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({
signalId: '<string>',
name: '<string>',
adapterConfig: {},
description: '<string>'
})
};
fetch('https://api.interchange.io/api/v2/storefront/esa/{esaId}/signals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{}{}{
"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": {}
}
}Storefront Ad Server Catalog
Create or dry-run a signal for an ad server source
Create a complete signal mapping on the upstream ad-server tenant. Set dry_run=true to validate and preview without persisting.
POST
/
esa
/
{esaId}
/
signals
Create or dry-run a signal for an ad server source
curl --request POST \
--url https://api.interchange.io/api/v2/storefront/esa/{esaId}/signals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"signalId": "<string>",
"name": "<string>",
"adapterConfig": {},
"description": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/storefront/esa/{esaId}/signals"
payload = {
"signalId": "<string>",
"name": "<string>",
"adapterConfig": {},
"description": "<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({
signalId: '<string>',
name: '<string>',
adapterConfig: {},
description: '<string>'
})
};
fetch('https://api.interchange.io/api/v2/storefront/esa/{esaId}/signals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{}{}{
"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
API key or access token
Path Parameters
Ad server source connection id. The wire field remains esaId for API compatibility.
Required range:
0 < x <= 9007199254740991Example:
123
Query Parameters
Validate and preview the upstream signal without persisting it.
Available options:
true Body
application/json
Pattern:
^[A-Za-z0-9_-]+$Minimum string length:
1Available options:
binary, categorical, numeric Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
generic, property, age Available options:
survey_based, assumptive, user_provided, user_verified AdCP vendor pricing option. A signal carries zero or more; absence means the signal is free. Forwarded verbatim to the managed ad-server source.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Response
Dry-run validation result when dry_run=true.