Jump to Content

Home Guides API Reference API Changelog

API Reference

Home Guides API Reference API Changelog

Getting Started

Overview
Introduction
Authentication
Requests
Responses
Status Codes
Errors
Pagination
Rate Limits
Versioning
impact.com Public IP Addresses

Accounts

Accounts overview
The account object
Retrieve an account
Update an account
The legal entity object
Retrieve a legal entity
List all legal entities

Actions

Actions overview
The action object
Retrieve an action
Update an action
Reverse an action
List all actions
The items object
Retrieve an item from an action
Update an item in an action
List all items for an action
The action updates object
Retrieve an action update
List all action updates

Action Inquiries

Action inquiries overview
The action inquiry object
Retrieve an action inquiry
Update an action inquiry
List all action inquiries

Ads

Ads overview
The ad object
Create an ad
Retrieve an ad
Update an ad
List all ads

Call Data

Call Data overview
Log Call Data

Catalogs

Catalogs overview
The catalog object
Retrieve a catalog
List all catalogs
The (catalog) item object
Create an item for a catalog
Retrieve an item from a catalog
Update an item or bulk update items for a catalog
Delete an item for a catalog
List all items for a catalog

Clicks

Clicks overview
The click object
Retrieve a click
Export clicks

Contacts

Contacts overview
The contact object
Create a contact
Retrieve a contact
Update a contact
Delete a contact
List all contacts

Contracts

Contracts overview
The contract object
Retrieve a contract
List all contracts

Conversions

Conversions overview
The conversion object
Create a conversion

Deals

Deals overview
The deal object
Create a deal
Retrieve a deal
Update a deal
Delete a deal
List all deals

Deferred Deep Linking

Deferred Deep Link overview
The deferred deep link object
Retrieve a deferred deep link

Deferred Response

Deferred Response Overview
Report Exports
- Schedule a new report jobpost
- Schedule a new report jobput
Click Exports
- Schedule a new clicks job.post
- Schedule a new clicks job.put

Exception Lists

Exception Lists overview
The exception list object
Create an exception list
Retrieve an exception list
Update an exception list
List all exception lists
The (exception list) item object
Create an item for an exception list
Retrieve an exception list item
Replace all items in an exception list
Delete an item for an exception list
Delete all items in an exception list
List all items for an exception list

Invoices

Invoices overview
The invoice object
Retrieve an invoice
Download an invoice PDF
List all invoices

Jobs management

Jobs overview
Jobs object
Return a job
Download a job result
Replay a job
Return a list of jobs

Notes

Notes overview
The note object
Create a note
Retrieve a note
Update a note
Delete a note
List all notes

Page Load

Page Load Overview
The Page Load object
Create a Page Load

Partners

Partners overview
The partner object
Create a partner
Retrieve a partner
Update a partner
List all partners

Partner Groups

Partner groups overview
The partner group object
Create a partner group
Retrieve a partner group
Update a partner group
Delete a partner group
List all partner groups

Phone Numbers

Phone Numbers overview
The PhoneNumbers object
Retrieve a PhoneNumber
List all PhoneNumbers

PROGRAMS

Programs overview
The program object
Retrieve a program
List all programs

Promo Codes

Promo codes overview
The promo code object
Create a promo code
Retrieve a promo code
Expire a promo code
List all promo codes

Reports

Report Export Overview
Export a report
List all reports
The report object
The report metadata object
Retrieve report metadata
Reports overview [Deprecation Planned]
Run a report [Deprecation Planned]
The report records object [Deprecation Planned]

Routing Rules

Routing rules overview
The routing rules object
Retrieve a routing rule
List all routing rules

Submissions

Submissions overview
The API submission object
Retrieve an API submission
List all API submissions
The FTP submission object
Retrieve an FTP Submission
List all FTP submissions
The FTP Submission Error object
List all FTP Submission Error details

Tasks

Tasks overview
The task object
Retrieve a task
List all tasks

Tracking Links

Tracking links overview
The tracking links object
Create a tracking link

Tracking Value Requests

(Tracking value) requests overview
The tracking value request object
Retrieve a tracking value request
Approve a tracking value request
Reject a tracking value request
List all tracking value requests

Unique URLs

Unique URLs overview
The unique URL object
Retrieve a unique URL
List all unique URLs

Webhooks

Enable Postbacks

Advocate REST API Reference

Account Overview
- Delete an accountdelete
User Overview
Share Links Overview
- Lookup a user's share URLsget
- Lookup a user's share URLs (Open Endpoint)get
Referral Code Overview
- Lookup a referral codeget
- Apply a referral codepost
Referral Overview
Reward Balance Overview
- List reward balancesget
- Debit a reward balancepost
Reward Overview
Webhook Overview
Export Overview
Advocate Error Codes

Getting Started

Overview
Introduction
Authentication
Requests
Responses
Status Codes
Errors
Pagination
Rate Limits
Versioning
impact.com Public IP Addresses

Accounts

Accounts overview
The account object
Retrieve an account
Update an account
The legal entity object
Retrieve a legal entity
List all legal entities

Actions

Actions overview
The action object
Retrieve an action
Update an action
Reverse an action
List all actions
The items object
Retrieve an item from an action
Update an item in an action
List all items for an action
The action updates object
Retrieve an action update
List all action updates

Action Inquiries

Action inquiries overview
The action inquiry object
Retrieve an action inquiry
Update an action inquiry
List all action inquiries

Ads

Ads overview
The ad object
Create an ad
Retrieve an ad
Update an ad
List all ads

Call Data

Call Data overview
Log Call Data

Catalogs

Catalogs overview
The catalog object
Retrieve a catalog
List all catalogs
The (catalog) item object
Create an item for a catalog
Retrieve an item from a catalog
Update an item or bulk update items for a catalog
Delete an item for a catalog
List all items for a catalog

Clicks

Clicks overview
The click object
Retrieve a click
Export clicks

Contacts

Contacts overview
The contact object
Create a contact
Retrieve a contact
Update a contact
Delete a contact
List all contacts

Contracts

Contracts overview
The contract object
Retrieve a contract
List all contracts

Conversions

Conversions overview
The conversion object
Create a conversion

Deals

Deals overview
The deal object
Create a deal
Retrieve a deal
Update a deal
Delete a deal
List all deals

Deferred Deep Linking

Deferred Deep Link overview
The deferred deep link object
Retrieve a deferred deep link

Deferred Response

Deferred Response Overview
Report Exports
- Schedule a new report jobpost
- Schedule a new report jobput
Click Exports
- Schedule a new clicks job.post
- Schedule a new clicks job.put

Exception Lists

Exception Lists overview
The exception list object
Create an exception list
Retrieve an exception list
Update an exception list
List all exception lists
The (exception list) item object
Create an item for an exception list
Retrieve an exception list item
Replace all items in an exception list
Delete an item for an exception list
Delete all items in an exception list
List all items for an exception list

Invoices

Invoices overview
The invoice object
Retrieve an invoice
Download an invoice PDF
List all invoices

Jobs management

Jobs overview
Jobs object
Return a job
Download a job result
Replay a job
Return a list of jobs

Notes

Notes overview
The note object
Create a note
Retrieve a note
Update a note
Delete a note
List all notes

Page Load

Page Load Overview
The Page Load object
Create a Page Load

Partners

Partners overview
The partner object
Create a partner
Retrieve a partner
Update a partner
List all partners

Partner Groups

Partner groups overview
The partner group object
Create a partner group
Retrieve a partner group
Update a partner group
Delete a partner group
List all partner groups

Phone Numbers

Phone Numbers overview
The PhoneNumbers object
Retrieve a PhoneNumber
List all PhoneNumbers

PROGRAMS

Programs overview
The program object
Retrieve a program
List all programs

Promo Codes

Promo codes overview
The promo code object
Create a promo code
Retrieve a promo code
Expire a promo code
List all promo codes

Reports

Report Export Overview
Export a report
List all reports
The report object
The report metadata object
Retrieve report metadata
Reports overview [Deprecation Planned]
Run a report [Deprecation Planned]
The report records object [Deprecation Planned]

Routing Rules

Routing rules overview
The routing rules object
Retrieve a routing rule
List all routing rules

Submissions

Submissions overview
The API submission object
Retrieve an API submission
List all API submissions
The FTP submission object
Retrieve an FTP Submission
List all FTP submissions
The FTP Submission Error object
List all FTP Submission Error details

Tasks

Tasks overview
The task object
Retrieve a task
List all tasks

Tracking Links

Tracking links overview
The tracking links object
Create a tracking link

Tracking Value Requests

(Tracking value) requests overview
The tracking value request object
Retrieve a tracking value request
Approve a tracking value request
Reject a tracking value request
List all tracking value requests

Unique URLs

Unique URLs overview
The unique URL object
Retrieve a unique URL
List all unique URLs

Webhooks

Enable Postbacks

Advocate REST API Reference

Account Overview
- Delete an accountdelete
User Overview
Share Links Overview
- Lookup a user's share URLsget
- Lookup a user's share URLs (Open Endpoint)get
Referral Code Overview
- Lookup a referral codeget
- Apply a referral codepost
Referral Overview
Reward Balance Overview
- List reward balancesget
- Debit a reward balancepost
Reward Overview
Webhook Overview
Export Overview
Advocate Error Codes

Referral Overview

A Referral tracks who has referred whom.

Endpoints
GET	List referrals
GET	Lookup a referral
GET	List referrals (Open Endpoint)

Submit a Ticket

|

|

|

|

|

|

© 2024 Impact Tech, Inc.