Pause or retire a buyer agent
curl --request POST \
--url https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/lifecycle-controls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"kind": "suspend",
"expectedLifecycleState": "active",
"confirmationText": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/lifecycle-controls"
payload = {
"kind": "suspend",
"expectedLifecycleState": "active",
"confirmationText": "<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({
kind: 'suspend',
expectedLifecycleState: 'active',
confirmationText: '<string>'
})
};
fetch('https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/lifecycle-controls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"kind": "suspend",
"applied": true,
"principalId": "<string>",
"lifecycleState": "suspended"
},
"error": null
}{
"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": {}
}
}{
"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": {}
}
}Buyer Agent Principals
Pause or retire a buyer agent
Pause or permanently retire a buyer agent independently of seller-account configuration. Every action requires the administrator to type the stored agent name, uses an optimistic lifecycle-state fence, commits with an exact-human audit record, and fails closed for impersonated, simulated, delegated, cross-organization, or cross-principal sessions. Existing V2 clients may continue to use the seller-context-bearing controls endpoint.
POST
/
buyer-agent-principals
/
{principalId}
/
lifecycle-controls
Pause or retire a buyer agent
curl --request POST \
--url https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/lifecycle-controls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"kind": "suspend",
"expectedLifecycleState": "active",
"confirmationText": "<string>"
}
'import requests
url = "https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/lifecycle-controls"
payload = {
"kind": "suspend",
"expectedLifecycleState": "active",
"confirmationText": "<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({
kind: 'suspend',
expectedLifecycleState: 'active',
confirmationText: '<string>'
})
};
fetch('https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/lifecycle-controls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"kind": "suspend",
"applied": true,
"principalId": "<string>",
"lifecycleState": "suspended"
},
"error": null
}{
"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": {}
}
}{
"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
Pattern:
^prin_[A-Za-z0-9_-]{32}$Body
application/json