Add a contact

Operation

POST /contacts/add

Adds a contact for an advertiser. Admin users only. This is the dedicated alias endpoint used by the add_contact tool. The submitted advertiser must resolve to a HiEnergy advertiser, and the contact is created only on that HiEnergy advertiser record.

Parameters

This operation does not define any parameters.

Request Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "contact": {
            "type": "object",
            "properties": {
              "advertiser_id": {
                "type": "integer",
                "description": "Advertiser id that must resolve to the HiEnergy advertiser record that will own the contact"
              },
              "email": {
                "type": "string",
                "format": "email"
              },
              "name": {
                "type": "string"
              },
              "given_name": {
                "type": "string"
              },
              "family_name": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              },
              "job_title": {
                "type": "string"
              },
              "source": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "linkedin_profile_url": {
                "type": "string",
                "format": "uri"
              }
            },
            "required": [
              "advertiser_id",
              "email"
            ]
          }
        },
        "required": [
          "contact"
        ]
      }
    }
  }
}

Responses

{
  "description": "Contact created",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object"
          }
        }
      }
    }
  }
}

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

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

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

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/contacts/add" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"
  -H "Content-Type: application/json" \
  -d '{}'