Skip to content
/
Enable UGC Capture

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

Search & Reports

Operations

Identify influencers

Operations

Helper endpoints

Operations

Import influencers

Operations

Influencer Page

Operations

Update Deal Info

Request

Updates the contact and profile information for an influencer deal. Use status_update_only: true to only update the active status without modifying other fields.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
deal_idstringrequired

The ID of the deal to update.

Example: "ETUNQ6ZTW1"
status_update_onlyboolean

If true, only updates the is_active status and ignores other fields.

Example: false
new_deal_infoobjectrequired

The updated deal information.

new_deal_info.​is_activeboolean

Whether the deal is active.

Example: true
new_deal_info.​main_namestring

The influencer's display name or handle.

Example: "therock"
new_deal_info.​notesstring

Internal notes about the deal.

Example: "Great engagement on recent posts"
new_deal_info.​emailstring

Primary email address.

Example: "contact@therock.com"
new_deal_info.​other_emailsstring

Additional email addresses.

Example: "manager@therock.com"
new_deal_info.​first_namestring

Influencer's first name.

Example: "Dwayne"
new_deal_info.​last_namestring

Influencer's last name.

Example: "Johnson"
new_deal_info.​address_linestring

Street address.

Example: "123 Main St"
new_deal_info.​citystring

City.

Example: "Los Angeles"
new_deal_info.​postcodestring

Postal code.

Example: "90001"
new_deal_info.​regionstring

State or region.

Example: "California"
new_deal_info.​countrystring

Country.

Example: "USA"
new_deal_info.​phone_nrstring

Phone number.

Example: "+1234567890"
new_deal_info.​has_managerboolean

Whether the influencer has a manager.

Example: true
new_deal_info.​manager_firstnamestring

Manager's first name.

Example: "John"
new_deal_info.​manager_lastnamestring

Manager's last name.

Example: "Smith"
new_deal_info.​manager_emailstring

Manager's email address.

Example: "john.smith@agency.com"
new_deal_info.​other_informationstring

Any other relevant information.

Example: "Preferred contact via manager"
curl -i -X POST \
  https://api.influencer-hero.com/v1/crm/update_deal_info \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "deal_id": "ETUNQ6ZTW1",
    "status_update_only": false,
    "new_deal_info": {
      "is_active": true,
      "main_name": "therock",
      "notes": "Great engagement on recent posts",
      "email": "contact@therock.com",
      "other_emails": "manager@therock.com",
      "first_name": "Dwayne",
      "last_name": "Johnson",
      "address_line": "123 Main St",
      "city": "Los Angeles",
      "postcode": "90001",
      "region": "California",
      "country": "USA",
      "phone_nr": "+1234567890",
      "has_manager": true,
      "manager_firstname": "John",
      "manager_lastname": "Smith",
      "manager_email": "john.smith@agency.com",
      "other_information": "Preferred contact via manager"
    }
  }'

Responses

Deal info successfully updated.

Bodyapplication/json
messagestring
deal_infoobject

The updated deal information.

Response
application/json
{
  "message": "Successfully updated deal info",
  "deal_info": {
    "deal_id": "ETUNQ6ZTW1",
    "main_name": "therock",
    "email": "contact@therock.com"
  }
}

Enable UGC Capture

Request

Enables or disables UGC (User Generated Content) capture for an influencer collaboration. When enabled, the system will automatically capture posts from the influencer's social media profiles. You can listen for UGC posts via webhooks or periodically retrieve the UGC posts from the API. Tracked UGC posts will also be available in the content library of your account.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
collab_idstring

The collaboration ID to update. Either collab_id or deal_id is required.

Example: "V2KYU6F9"
deal_idstring

The deal ID to update. Either collab_id or deal_id is required.

Example: "ETUNQ6ZTW1"
post_capture_statusbooleanrequired

Whether to enable (true) or disable (false) UGC capture.

Example: true
post_capture_untilinteger

Unix timestamp until when to capture posts. This can help save UGC capture credits. Optional.

Example: 1735689600
post_capture_disable_on_postboolean

If true, automatically disables capture after a post is detected. This can help save UGC capture credits.

Example: false
curl -i -X POST \
  https://api.influencer-hero.com/v1/crm/update_post_capture \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "collab_id": "V2KYU6F9",
    "deal_id": "ETUNQ6ZTW1",
    "post_capture_status": true,
    "post_capture_until": 1735689600,
    "post_capture_disable_on_post": false
  }'

Responses

UGC capture settings updated successfully.

Bodyapplication/json
Response
application/json
{
  "message": "UGC Capture updated"
}

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

Managing Webhooks

Operations

Webhooks

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

Webhooks