Publishers API Documentation

Overview

The Publishers API lets you create publishers, view publishers, and update the publisher you are authorized to access. All authenticated users can read publisher records. Admin users can create publishers. Publisher account admins can update basic publisher settings (name, domain) and network API keys and credentials. Admin users can additionally update admin-only publisher settings such as account_manager_id, application_requests_enabled, hide_deals, link_generator_enabled, slack_channel, description, agent_prompt, and last_paid_at.

MCP Server

Prefer calling these workflows from an MCP-compatible client? The MCP server exposes the named create_publisher tool and the generic api_request bridge for the wider API surface.

Endpoints

API Playground

Use the table below to see how to perform common actions. Click Test to run a GET request and preview the JSON response, or Open to open the URL in a new tab. PATCH requests must be sent with a JSON body (e.g. via curl or your app). Sign in to enable live testing with your API key.

Create/Update Parameters

Pass a publisher object. name is required for create requests. All other fields are optional, but your role determines which attributes may be updated.

Response Format

JSON:API-style data with publisher attributes. Responses include name, domain, account_manager_id, description, agent_prompt, slug, application_requests_enabled, hide_deals, link_generator_enabled, slack_channel, last_paid_at, and updated_at. Network credential values are intentionally omitted from GET and PATCH responses. Example GET response:

{
  "data": {
    "id": "42",
    "type": "publisher",
    "attributes": {
      "name": "My Affiliate Site",
      "domain": "mysite.com",
      "account_manager_id": 7,
      "description": "Creator commerce publisher",
      "agent_prompt": "Prioritize creator-first programs.",
      "slug": "my-affiliate-site",
      "application_requests_enabled": true,
      "hide_deals": false,
      "link_generator_enabled": true,
      "slack_channel": "#publisher-team",
      "last_paid_at": "2026-02-07T00:00:00.000Z",
      "updated_at": "2024-06-15T14:30:00.000Z"
    }
  }
}

HTTP Examples

Copy-paste examples for common operations. Replace YOUR_API_KEY and :id with your values.

curl -X GET "https://app.hienergy.ai/api/v1/publishers/42" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

curl -X GET "https://app.hienergy.ai/api/v1/publishers/my-affiliate-site" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

curl -X GET "https://app.hienergy.ai/api/v1/publishers/42?api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json"

curl -X PATCH "https://app.hienergy.ai/api/v1/publishers/42" \
  -H "X-Api-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"publisher": {"name": "Updated Site Name"}}'

curl -X PATCH "https://app.hienergy.ai/api/v1/publishers/42" \
  -H "X-Api-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"publisher": {"domain": "newsite.com", "flexoffers_api_key": "fo_xxx", "partnerize_api_key": "pr_xxx"}}'

curl -X PATCH "https://app.hienergy.ai/api/v1/publishers/42" \
  -H "X-Api-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"publisher": {"application_requests_enabled": true, "hide_deals": false, "link_generator_enabled": true, "slack_channel": "#publisher-team", "description": "Creator commerce publisher", "agent_prompt": "Prioritize creator-first programs.", "last_paid_at": "2026-02-07", "account_manager_id": 7}}'

const response = await fetch('https://app.hienergy.ai/api/v1/publishers/42', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' }
});
const data = await response.json();

const response = await fetch('https://app.hienergy.ai/api/v1/publishers/42', {
  method: 'PATCH',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ publisher: { name: 'New Name', flexoffers_api_key: 'your_key' } })
});
const data = await response.json();

import requests
response = requests.get('https://app.hienergy.ai/api/v1/publishers/42', headers={'X-Api-Key': 'YOUR_API_KEY'})
data = response.json()

import requests
response = requests.patch('https://app.hienergy.ai/api/v1/publishers/42',
    headers={'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json'},
    json={'publisher': {'name': 'New Name', 'domain': 'example.com'}})
data = response.json()

{"error": "Unauthorized", "message": "Invalid or missing API credentials"}

{"error": "Forbidden", "message": "You are not authorized to update this publisher"}

{"error": "Not Found", "message": "Publisher not found"}

Network Credentials

The API accepts all supported network API key fields (e.g. cj_pid, cj_access_token, rakuten_client_id, impact_account_sid, partnerize_api_key, flexoffers_api_key, pepperjam_api_key, sas_*, avantlink_*, skimlinks_*, webgains_*, tradedoubler_*, tradetracker_*, levanta_*, linkconnector_api_key, optimise_*, loyalize_*, digidip_*, hubspot_access_token, hubspot_account_id). Use PATCH to update them. GET responses never include the credential values.

Error Handling

• 401 Unauthorized: missing or invalid API key.
• 403 Forbidden: not allowed to update this publisher.
• 404 Not Found: publisher id or slug does not exist.
• 422 Unprocessable Entity: validation errors; response includes errors array.

Frequently Asked Questions