Create a publisher

Operation

POST /publishers

Creates a new publisher record. This endpoint is admin-only. You must provide a publisher object with at least a name. Network credential values may be supplied at creation time, but they are never echoed back in responses.

Parameters

This operation does not define any parameters.

Request Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "publisher": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "domain": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "agent_prompt": {
                "type": "string"
              },
              "account_manager_id": {
                "type": "integer"
              },
              "application_requests_enabled": {
                "type": "boolean"
              },
              "hide_deals": {
                "type": "boolean"
              },
              "link_generator_enabled": {
                "type": "boolean"
              },
              "slack_channel": {
                "type": "string"
              },
              "company_type": {
                "type": "string",
                "enum": [
                  "network",
                  "publisher",
                  "advertiser",
                  "agency"
                ]
              },
              "publisher_type": {
                "type": "string",
                "enum": [
                  "Content & Blogs",
                  "Influencers & Creators",
                  "Coupon & Deals",
                  "Cashback & Loyalty",
                  "Email & Newsletters",
                  "Communities & Memberships",
                  "Comparison & Review Sites",
                  "Tools & Utilities"
                ]
              },
              "headquarters": {
                "type": "string"
              },
              "network_id": {
                "type": "integer"
              },
              "last_paid_at": {
                "type": "string",
                "format": "date"
              }
            },
            "required": [
              "name"
            ]
          }
        },
        "required": [
          "publisher"
        ]
      },
      "examples": {
        "basic_create": {
          "summary": "Create a publisher with core metadata",
          "value": {
            "publisher": {
              "name": "Acme Media",
              "domain": "acme.example",
              "description": "Created through the API",
              "application_requests_enabled": true
            }
          }
        }
      }
    }
  }
}

Responses

{
  "description": "Publisher created",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/Publisher"
          }
        }
      }
    }
  }
}

{
  "$ref": "#/components/responses/Unauthorized"
}

{
  "$ref": "#/components/responses/Forbidden"
}

{
  "description": "Validation errors",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

API Playground

The in-page tester only supports GET. For POST, use the sample curl below or the dedicated resource docs (e.g. Contacts, Link Builder). Sign in to enable live testing with your API key.

Example request (replace YOUR_API_KEY or sign in above):

curl -X POST "https://app.hienergy.ai/api/v1/publishers" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"
  -H "Content-Type: application/json" \
  -d '{}'