API Reference
Start typing to search…

The user object

Attributes

Id string

Unique identifier for the account user.

FirstName string

First name of the account user.

LastName string

Last name of the account user.

Type enum

The type of user that the account user is.

Possible enum values
MEMBERIndicates the user is a standard impact.com member account.
MANAGER_ACCOUNTIndicates the user is an agency account managing your partner account.

State enum

The account state of the user.

Possible enum values
ACTIVEUser is currently active and can access your partner account.
PENDINGUser has accepted an invitation but is pending approval from an account administrator.
INVITEDUser has been invited and needs to accept the invitation sent to their email account.

Language string

The account language preference of the user.

AccessRights array

An object containing the roles and associated permissions the user has. Each permission value is associated with a specific role—if a user has that permission, that role will be listed.

View child attributes…

Role string

Lists the role associated with the permissions the user has.

Permissions array

Lists the permissions the user has.

Possible enum values
MANAGE_DIRECTORY_INFOLegacy permission setting that permitted a user to manage directory information. Part of the Account Administration role.
RUN_USAGE_REPORTSPermits a user to run the Admin reports found in Reports → All Reports. Part of the Account Administration role.
MANAGE_ACCOUNT_INFOPermits the user to manage information about the account found in the General section in ⋮ → Settings. Part of the Account Administration role.
NEGOTIATE_AGREEMENTSPermits a user to negotiate contract agreements with a brand—managing proposed contracts, countering a proposed contract (if permitted by the brand), accepting contracts, and declining contracts. Part of the Advertiser Management role.
REQUEST_CAP_EXTENSIONS_AND_AGREEMENT_EXCEPTIONSPermits a user to request that a brand extend action cap limits and exceptions to limitations stipulated in a contract. Part of the Advertiser Management role.
SEND_MARKETING_MSG_TO_BRANDPermits a user to send marketing messages to brands found on the My Brands screen. Part of the Advertiser Management role.
VIEW_BRAND_INFOPermits a user to view brand info found on the My Brands screen. Part of the Advertiser Management role.
APPLY_TO_CAMPAIGNPermits a user to apply to programs (campaigns) found in the Brands Marketplace. Part of the Advertiser Management role.
RUN_ACTION_AND_PERFORMANCE_REPORTSPermits a user to run the Action Listing and Performance reports found in [Top Nav Bar] → Reports → All Reports. Part of the Advertiser Management role.
REQUEST_CUSTOM_ADSPermits a user to request custom ads from brands that allow partners to do so. Part of the Creative Management role.
APPROVE_CREATIVE_AND_DUB_HOUSE_EXPENSESLegacy setting that permits a user to approve dubbing house and/or creative expenses for TV & Radio ads.
MANAGE_CREATIVESLegacy setting that permits a user to manage creative for TV & Radio ads.
RUN_CREATIVE_REPORTSLegacy setting that permits a user to run reports related to creative and dub house expenses.
GET_AD_HTMLPermits a user to retrieve the HTML, iframe, and tracking link code for available ads.
VIEW_FINANCIALSPermits a user to view finance settings in the Balance menu of the platform.
MANAGE_FINANCIAL_SETTINGSPermits a user to manage financial settings, such as adding a bank account and initiating funds transfers to brands.
RUN_FINANCIAL_TRANSACTION_REPORTSPermits a user to run the finanical reports available in the Balance menu of the platform.
WEBSERVICES_INTEGRATIONPermits a user to enable API access for the account and view access credentials.
EVENT_CALLBACK_INTEGRATIONPermits a user to configure event notification postbacks.
RUN_TECHNICAL_REPORTSPermits a user to run technical reports found in Reports → All Reports.
TRACKER_AND_BRAND_URL_INTEGRATIONSPermits a user to manage technical integration settings (partner tracking pixels, postbacks) on a per-brand basis.
ITEM_LIST_INTEGRATIONSPermits a user to view and manage product catalogs.

JoinedDate datetime

Date and time the user joined the partner account, expressed in ISO 8416 format.

DateLastUpdated datetime

Date and time the user's information was last updated, expressed in ISO 8416 format.

CreatedBy string

Only relevant for direct programs—the name of the brand user that created the partner account user.

Uri string

The direct URI to the user.

{
  "Id": "I-1234567",
  "FirstName": "Wile",
  "LastName": "Coyote",
  "Username": "WileECoyote",
  "Type": "MEMBER",
  "State": "ACTIVE",
  "Language": "en_US",
  "AccessRights": [
    {
      "Role": "Creative Management",
      "Permissions": [
        "GET_AD_HTML",
        "REQUEST_CUSTOM_ADS",
        "RUN_CREATIVE_REPORTS",
        "APPROVE_CREATIVE_AND_DUB_HOUSE_EXPENSES",
        "MANAGE_CREATIVES"
      ]
    },
    {
      "Role": "Finance",
      "Permissions": [
        "MANAGE_FINANCIAL_SETTINGS",
        "VIEW_FINANCIALS",
        "RUN_FINANCIAL_TRANSACTION_REPORTS"
      ]
    },
    {
      "Role": "Advertiser Management",
      "Permissions": [
        "APPLY_TO_CAMPAIGN",
        "RUN_ACTION_AND_PERFORMANCE_REPORTS",
        "REQUEST_CAP_EXTENSIONS_AND_AGREEMENT_EXCEPTIONS",
        "NEGOTIATE_AGREEMENTS",
        "SEND_MARKETING_MSG_TO_BRAND",
        "VIEW_BRAND_INFO"
      ]
    },
    {
      "Role": "Technical",
      "Permissions": [
        "WEBSERVICES_INTEGRATION",
        "ITEM_LIST_INTEGRATIONS",
        "RUN_TECHNICAL_REPORTS",
        "TRACKER_AND_BRAND_URL_INTEGRATIONS",
        "EVENT_CALLBACK_INTEGRATION"
      ]
    },
    {
      "Role": "Account Administration",
      "Permissions": [
        "RUN_USAGE_REPORTS",
        "MANAGE_DIRECTORY_INFO",
        "MANAGE_ACCOUNT_INFO"
      ]
    }
  ],
  "JoinedDate": "2020-04-29T16:24:13-07:00",
  "DateLastUpdated": "2020-12-09T08:34:06-08:00",
  "LastUpdatedBy": "WileECoyote",
  "CreatedBy": "RoadRunner",
  "Uri": "/Mediapartners/<AccountSID>/Users/I-1234567"
}