Skip to content

Influencer Hero API (1.4.2)

API documentation for the Influencer Hero platform.

Download OpenAPI description
Languages
Servers
https://api.influencer-hero.com/

Test endpoints

Endpoints to test authenticated and public requests

Operations
Operations
Operations
Operations
Operations

Request

Creates a new influencer deal page in the specified campaign board/dealflow. The difference between this and the "Submit Influencers to campaign" endpoint is that this directly adds the influencer to the CRM, bypassing the outreach step. This is useful for manually adding influencers that you already work with or have a relationship with. This is like manually adding an influencer via the CSV import feature.

Security
ApiKeyAuth
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' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -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." }

Request

This endpoint adds the influencers to the specified campaign. The influencer is scheduled for outreach if the campaign is set to send one. This is like adding influencers to a campaign from the Influencer Finder.

Credit Usage:

  • Each influencer added costs 0.04 search credits.
  • Duplicate influencers (already in the account) are automatically skipped.
Security
ApiKeyAuth
Bodyapplication/jsonrequired
outreach_idstringrequired

The ID of the outreach campaign to add influencers to.

Example: "O_I4SFHB"
influencer_idsArray of stringsrequired

List of influencer user IDs to add to the campaign.

Example: ["703787","703739","703738"]
platformstringrequired

The social media platform of the influencers.

Enum"instagram""tiktok""youtube"
Example: "instagram"
curl -i -X POST \
  https://api.influencer-hero.com/v1/search/submit_influencers \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "outreach_id": "O_I4SFHB",
    "influencer_ids": [
      "703787",
      "703739",
      "703738"
    ],
    "platform": "instagram"
  }'

Responses

Influencers successfully added to the campaign.

Bodyapplication/json
messagestring

Summary message of the operation.

total_addedinteger

Number of influencers successfully added.

duplicates_ignoredinteger

Number of duplicate influencers that were skipped.

successboolean
statusinteger
Response
application/json
{ "message": "5 influencers added to the campaign and 2 duplicates ignored.", "total_added": 5, "duplicates_ignored": 2, "success": true, "status": 200 }
Operations

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
Operations

Webhooks

Receive real-time notifications when events occur in your account. Webhooks are secured via HMAC-SHA256 signatures.

Webhooks