Update a publisher

Operation

PATCH /publishers/{id}

Updates publisher attributes. Non-admin publisher account admins can edit a base set of fields (description, agent_prompt, slack_channel, linkedin_profile_url, application/hide_deals/link_generator flags). Admin callers can additionally change ownership, company/publisher_type, network_id, account_manager_id, and paid-publisher status.

Parameters

Request Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "publisher": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "Admin-only"
              },
              "domain": {
                "type": "string",
                "description": "Admin-only"
              },
              "description": {
                "type": "string"
              },
              "agent_prompt": {
                "type": "string"
              },
              "slack_channel": {
                "type": "string"
              },
              "linkedin_profile_url": {
                "type": "string",
                "format": "uri"
              },
              "application_requests_enabled": {
                "type": "boolean"
              },
              "hide_deals": {
                "type": "boolean"
              },
              "link_generator_enabled": {
                "type": "boolean"
              },
              "account_manager_id": {
                "type": "integer",
                "description": "Admin-only"
              },
              "company_type": {
                "type": "string",
                "description": "Admin-only"
              },
              "publisher_type": {
                "type": "string",
                "description": "Admin-only"
              },
              "network_id": {
                "type": "integer",
                "description": "Admin-only"
              },
              "headquarters": {
                "type": "string",
                "description": "Admin-only"
              },
              "last_paid_at": {
                "type": "string",
                "format": "date",
                "description": "Admin-only"
              }
            }
          }
        },
        "required": [
          "publisher"
        ]
      },
      "examples": {
        "account_admin_update": {
          "summary": "Account admin updating their publisher's public profile",
          "value": {
            "publisher": {
              "description": "Leading cashback site in France",
              "slack_channel": "#acme-alerts"
            }
          }
        }
      }
    }
  }
}

Responses

{
  "description": "Updated publisher",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/Publisher"
          }
        },
        "required": [
          "data"
        ]
      }
    }
  }
}

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

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

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

{
  "description": "Validation errors",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

API Playground

The in-page tester only supports GET. For PATCH, 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 PATCH "https://app.hienergy.ai/api/v1/publishers/1" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"
  -H "Content-Type: application/json" \
  -d '{}'