> ## Documentation Index > Fetch the complete documentation index at: https://docs.interchange.io/llms.txt > Use this file to discover all available pages before exploring further. # Apply a confirmed buyer-agent configuration control > Create or replace one caller-level webhook subscription, pause, reactivate, or remove it; deactivate one exact reporting-destination generation; suspend a principal; or permanently retire it. Every action requires the administrator to type the stored buyer-agent display name, uses an optimistic state fence, commits with an exact-human audit record, and fails closed for impersonated, simulated, delegated, cross-organization, or cross-principal sessions. Webhook URLs are SSRF-validated and credentials are neither accepted nor returned. No action grants advertiser, account, spend, payment, or Terms authority. ## OpenAPI ````yaml /v2/buyer-api-v2.yaml post /buyer-agent-principals/{principalId}/controls openapi: 3.0.0 info: title: Scope3 Buyer API version: 2.0.0 description: |- REST API for advertisers to manage advertisers, campaigns, and reporting. ## Authentication All endpoints require a Bearer token in the Authorization header: ``` Authorization: Bearer your-api-key ``` ## Base URL `https://api.interchange.io/api/v2/buyer` ## For AI Agents AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools: - `initialize`: Start an MCP session - `api_call`: Make REST API calls - `ask_about_capability`: Learn about API features servers: - url: https://api.interchange.io/api/v2/buyer description: Production server security: [] tags: - name: Signup description: Request reviewed access to Interchange - name: Account description: Account management, service tokens, and preferences - name: Asks description: >- What you are waiting on Scope3 for — support, product, and supply asks in one list - name: Advertisers description: Manage advertisers - name: Product Discovery description: Discover and select products - name: Campaigns description: Manage advertising campaigns - name: Creatives description: Build, manage, and sync campaign creatives via AdCP Creative Protocol - name: Reporting description: Access performance metrics - name: Event Sources description: >- Manage event source configurations and log conversion/marketing events for attribution - name: Property Lists description: Validate property lists against AAO registry - name: Sales Agents description: View and connect sales agents - name: Measurement description: Measurement sources, records, context, and freshness - name: Syndication description: Syndicate resources to ADCP agents - name: Tasks description: Track async operation status - name: Buyer Billing description: >- Consolidated invoicing for buyers — invoices and pending invoice items issued by Scope3 across the buyer customer. - name: MCP description: Model Context Protocol endpoints for AI agents paths: /buyer-agent-principals/{principalId}/controls: servers: - url: https://api.interchange.io/api/v2 description: Production server post: tags: - Buyer Agent Principals summary: Apply a confirmed buyer-agent configuration control description: >- Create or replace one caller-level webhook subscription, pause, reactivate, or remove it; deactivate one exact reporting-destination generation; suspend a principal; or permanently retire it. Every action requires the administrator to type the stored buyer-agent display name, uses an optimistic state fence, commits with an exact-human audit record, and fails closed for impersonated, simulated, delegated, cross-organization, or cross-principal sessions. Webhook URLs are SSRF-validated and credentials are neither accepted nor returned. No action grants advertiser, account, spend, payment, or Terms authority. operationId: controlBuyerAgentPrincipal parameters: - in: path name: principalId schema: type: string pattern: ^prin_[A-Za-z0-9_-]{32}$ required: true requestBody: required: true content: application/json: schema: oneOf: - type: object properties: kind: type: string enum: - deactivate_destination storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 destinationId: type: string pattern: ^[A-Za-z0-9_.:-]{1,64}$ generation: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 expectedConfigurationVersion: type: string minLength: 1 maxLength: 255 confirmationText: type: string minLength: 1 maxLength: 255 description: >- Exact buyer-agent display name typed by the administrator. required: - kind - storefrontId - destinationId - generation - expectedConfigurationVersion - confirmationText additionalProperties: false - type: object properties: kind: type: string enum: - deactivate_subscriber storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 subscriberId: type: string pattern: ^[A-Za-z0-9_.:-]{1,128}$ expectedConfigurationVersion: type: string minLength: 1 maxLength: 255 confirmationText: type: string minLength: 1 maxLength: 255 description: >- Exact buyer-agent display name typed by the administrator. required: - kind - storefrontId - subscriberId - expectedConfigurationVersion - confirmationText additionalProperties: false - type: object properties: kind: type: string enum: - replace_subscriber storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 subscriberId: type: string pattern: ^[A-Za-z0-9_.:-]{1,64}$ endpointUrl: type: string format: uri eventTypes: minItems: 1 maxItems: 64 type: array items: anyOf: - type: string enum: - scheduled - type: string enum: - final - type: string enum: - delayed - type: string enum: - adjusted - type: string enum: - window_update - type: string enum: - impairment - type: string enum: - creative.status_changed - type: string enum: - creative.assignment_changed - type: string enum: - indicators.changed - type: string enum: - creative.purged - type: string enum: - account.status_changed - type: string enum: - account.change_recorded - type: string enum: - product.created - type: string enum: - product.updated - type: string enum: - product.priced - type: string enum: - product.removed - type: string enum: - signal.created - type: string enum: - signal.updated - type: string enum: - signal.priced - type: string enum: - signal.removed - type: string enum: - wholesale_feed.bulk_change - type: string enum: - capabilities.changed - type: string enum: - reporting.delivery_ready - type: string enum: - reporting.status_changed - type: string enum: - reporting.ledger_changed - type: string enum: - principal.changed active: default: true type: boolean allAuthorizedAccounts: default: false type: boolean includeFutureEventTypes: default: false type: boolean expectedConfigurationVersion: type: string minLength: 1 maxLength: 255 confirmationText: type: string minLength: 1 maxLength: 255 description: >- Exact buyer-agent display name typed by the administrator. required: - kind - storefrontId - subscriberId - endpointUrl - eventTypes - expectedConfigurationVersion - confirmationText additionalProperties: false - type: object properties: kind: type: string enum: - pause_subscriber storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 subscriberId: type: string pattern: ^[A-Za-z0-9_.:-]{1,64}$ expectedConfigurationVersion: type: string minLength: 1 maxLength: 255 confirmationText: type: string minLength: 1 maxLength: 255 description: >- Exact buyer-agent display name typed by the administrator. required: - kind - storefrontId - subscriberId - expectedConfigurationVersion - confirmationText additionalProperties: false - type: object properties: kind: type: string enum: - reactivate_subscriber storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 subscriberId: type: string pattern: ^[A-Za-z0-9_.:-]{1,64}$ expectedConfigurationVersion: type: string minLength: 1 maxLength: 255 confirmationText: type: string minLength: 1 maxLength: 255 description: >- Exact buyer-agent display name typed by the administrator. required: - kind - storefrontId - subscriberId - expectedConfigurationVersion - confirmationText additionalProperties: false - type: object properties: kind: type: string enum: - remove_subscriber storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 subscriberId: type: string pattern: ^[A-Za-z0-9_.:-]{1,64}$ expectedConfigurationVersion: type: string minLength: 1 maxLength: 255 confirmationText: type: string minLength: 1 maxLength: 255 description: >- Exact buyer-agent display name typed by the administrator. required: - kind - storefrontId - subscriberId - expectedConfigurationVersion - confirmationText additionalProperties: false - type: object properties: kind: type: string enum: - suspend storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 expectedLifecycleState: type: string enum: - active confirmationText: type: string minLength: 1 maxLength: 255 description: >- Exact buyer-agent display name typed by the administrator. required: - kind - storefrontId - expectedLifecycleState - confirmationText additionalProperties: false - type: object properties: kind: type: string enum: - retire storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 expectedLifecycleState: type: string enum: - active - suspended confirmationText: type: string minLength: 1 maxLength: 255 description: >- Exact buyer-agent display name typed by the administrator. required: - kind - storefrontId - expectedLifecycleState - confirmationText additionalProperties: false type: object responses: '200': description: Apply a confirmed buyer-agent configuration control content: application/json: schema: $ref: '#/components/schemas/BuyerAgentPrincipalControlApiResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The caller is not a directly authenticated WorkOS organization administrator, or the principal is outside the verified organization. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- The buyer-agent principal, subscriber, or destination does not exist in the verified organization and storefront scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The supplied configuration version, destination generation, or lifecycle state is stale, or the selected control is already inactive. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: BuyerAgentPrincipalControlApiResponse: type: object properties: data: oneOf: - type: object properties: kind: type: string enum: - deactivate_destination - deactivate_subscriber - replace_subscriber - pause_subscriber - reactivate_subscriber - remove_subscriber applied: type: boolean enum: - true principalId: type: string pattern: ^prin_[A-Za-z0-9_-]{32}$ storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 configurationVersion: type: string minLength: 1 maxLength: 255 required: - kind - applied - principalId - storefrontId - configurationVersion additionalProperties: false - type: object properties: kind: type: string enum: - suspend applied: type: boolean enum: - true principalId: type: string pattern: ^prin_[A-Za-z0-9_-]{32}$ storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 lifecycleState: type: string enum: - suspended required: - kind - applied - principalId - storefrontId - lifecycleState additionalProperties: false - type: object properties: kind: type: string enum: - retire applied: type: boolean enum: - true principalId: type: string pattern: ^prin_[A-Za-z0-9_-]{32}$ storefrontId: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 lifecycleState: type: string enum: - retired required: - kind - applied - principalId - storefrontId - lifecycleState additionalProperties: false type: object error: type: string nullable: true enum: - null required: - data - error additionalProperties: false ErrorResponse: type: object properties: data: type: string nullable: true enum: - null error: $ref: '#/components/schemas/ApiError' required: - data - error additionalProperties: false description: Standard error response ApiError: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable error message field: description: Field path associated with the error type: string details: description: Additional error context type: object additionalProperties: {} required: - code - message additionalProperties: false description: Structured error object securitySchemes: bearerAuth: type: http scheme: bearer description: API key or access token ````