CRM

Influencer Hero API (1.4.2)

API documentation for the Influencer Hero platform.

Download OpenAPI description
ih_api.json
ih_api.yaml
Overview
URL

https://help.influencer-hero.com/

Influencer Hero Support

support@influencer-hero.com

Languages
Servers

https://api.influencer-hero.com/

Test endpoints

Endpoints to test authenticated and public requests

Operations

CRM

Endpoints related to CRM functionalities.

Operations

Identify Influencers

Request

Identifies influencers based on contact details. Matched influencers will appear in the "Your customers" tab of the influencer finder.

Bodyapplication/jsonrequired
influencer_listArray of stringsrequired

List of email addresses.

Example: ["influencer1@example.com","influencer2@example.com"]
brand_idinteger

ID of the brand. If not provided, the first brand in the account will be used.

Example: 4819
source_typestring

Source type for your reference (will be shown in the IH dashboard).

Example: "sendinblue"
curl -i -X POST \
  https://api.influencer-hero.com/v1/search/identify_influencers \
  -H 'Content-Type: application/json' \
  -d '{
    "influencer_list": [
      "influencer1@example.com",
      "influencer2@example.com"
    ],
    "brand_id": 4819,
    "source_type": "sendinblue"
  }'

Responses

Successfully sent contact details to the processing queue.

Bodyapplication/json
Response
application/json
{
  "message": "Successfully sent contact details to queue. Please allow for up to an hour for processing.",
  "success": true
}

Get Deal Information

Request

Retrieves information about a specific deal in the CRM.

Query
influencer_handlestring

Influencer handle. Either deal_id or influencer_handle is required.

Example: influencer_handle=therock
deal_idstring

Deal ID or URL. Either deal_id or influencer_handle is required.

Example: deal_id=ETUNQ6ZTW1
curl -i -X GET \
  'https://api.influencer-hero.com/v1/crm/get_deal_details?deal_id=ETUNQ6ZTW1&influencer_handle=therock'

Responses

Success response

Bodyapplication/json
Response
application/json
{
  "deal_info": {
    "id": "ETUNQ6ZTW1",
    "influencer_handle": "therock",
    "brand_id": 4819,
    "is_active": true
  }
}

Import Influencer

Request

Creates a new deal in your CRM.

Bodyapplication/jsonrequired
influencer_handlestringrequired

Influencer handle.

Example: "therock"
platformstringrequired

Social media platform.

Example: "instagram"
first_namestring

Influencer's first name.

Example: "Dwayne"
last_namestring

Influencer's last name.

Example: "Johnson"
emailstring

Influencer's email address.

Example: "dwayne.johnson@example.com"
brand_idintegerrequired

Brand ID.

Example: 4819
dealflow_idstringrequired

Dealflow ID.

Example: "D_FSSI4P"
funnel_stepinteger

The funnel step to set for the deal.

Example: 2
address_linestring

Street address or other address details.

Example: "123 Hollywood Blvd"
postcodestring

Postal code.

Example: "90038"
regionstring

Region or state.

Example: "California"
citystring

City of residence.

Example: "Los Angeles"
country_codestring

Country code (e.g., 'US', 'GB').

Example: "US"
phone_nrstring

Phone number.

Example: "+1 310 555 0100"
total_payoutsnumber

Total payouts already made to this influencer.

Example: 250
total_commission_earnednumber

Total commission earned by this influencer so far.

Example: 500.5
total_fixed_fee_earnednumber

Total fixed fee earned by this influencer so far.

Example: 1000
total_salesnumber

Total sales so far attributed to this influencer.

Example: 4500
total_referralsnumber

Total referral count from this influencer.

Example: 25
codestring

Discount code to associate with the collaboration.

Example: "THEROCK50"
code_percnumber

Percentage discount for the code (0 to 100).

Example: 15
custom_urlstring

Custom affiliate URL to track.

Example: "/therock"
custom_url_targetstring

Landing page or reference name for custom_url.

Example: "/"
commission_percnumber

Commission percentage for affiliate sales.

Example: 10
create_affiliate_detailsboolean

Whether to create affiliate details automatically. If true, we will create the discount code and custom link (if there are any) in your shopify/CMS integration. If not we will just insert it in the deal page (sales with that discount code will still be correctly tracked)

Example: true
curl -i -X POST \
  https://api.influencer-hero.com/v1/crm/create_deal \
  -H 'Content-Type: application/json' \
  -d '{
    "influencer_handle": "therock",
    "platform": "instagram",
    "first_name": "Dwayne",
    "last_name": "Johnson",
    "email": "dwayne.johnson@example.com",
    "brand_id": 4819,
    "dealflow_id": "D_FSSI4P",
    "funnel_step": 2,
    "address_line": "123 Hollywood Blvd",
    "postcode": "90038",
    "region": "California",
    "city": "Los Angeles",
    "country_code": "US",
    "phone_nr": "+1 310 555 0100",
    "total_payouts": 250,
    "total_commission_earned": 500.5,
    "total_fixed_fee_earned": 1000,
    "total_sales": 4500,
    "total_referrals": 25,
    "code": "THEROCK50",
    "code_perc": 15,
    "custom_url": "/therock",
    "custom_url_target": "/",
    "commission_perc": 10,
    "create_affiliate_details": true
  }'

Responses

Successfully created deal.

Bodyapplication/json
Response
application/json
{
  "deal_id": "ETUNQ6ZTW1",
  "deal_page_url": "https://app.influencer-hero.com/deal/ETUNQ6ZTW1",
  "message": "Successfully created deal."
}

Affiliate Tracking

[Advanced] Server-side endpoints for tracking affiliate actions and performance. For most use cases, the client-side tracking script will be sufficient.

Operations

Account

Account-related functionalities for dealflow and brand searching.

Operations

Search

Endpoints for the influencer-finder search operations

Operations

webhooks

Webhooks