adAccounts

  • Article

The LinkedIn ads platform allows advertisers to create multiple accounts for both Text Ads and Sponsored Content. Use the Ad Accounts API to create and manage accounts.

Supported Methods

CREATE | GET | SEARCH FINDER | UPDATE

Schema

Field Name Type Description
currency string, default="USD" The ISO 4217 currency code of the account, such as 'USD' for United States Dollar. Note: Advertisers selecting BRL as a currency will see their account budget, advertising bids, and spend in BRL, but their account will be billed in USD. We recommend communicating this to advertisers in your application if they opt for BRL. Learn more
id long Unique internal ID representing the account.
name string A label for the account.
notifiedOnCampaignOptimization boolean, default="false" Indicates if the campaign contact is notified about campaign optimization opportunities.
notifiedOnCreativeApproval boolean, default="false" Indicates if the creative contact is notified when a creative has been reviewed and approved.
notifiedOnCreativeRejection boolean, default="false" Indicates if the creative contact is notified when a creative has been rejected due to content.
notifiedOnEndOfCampaign boolean, default="false" Indicates if the campaign contact is notified when an associated campaign has been completed.
notifiedOnNewFeaturesEnabled boolean, default="false" Indicates if the account owner is notified about new Campaign Manager features.
reference optional URN The entity on whose behalf the account advertises. Must either be in the format urn:li:person:{id} or urn:li:organization:{id}.
servingStatuses string[], default="[]" An array of enums with information about the account's system serving statuses. If an account is eligible for serving, then this array will have a single element:
  • RUNNABLE
Otherwise, this array will contain one or more reasons why the account is not servable:
  • STOPPED
  • BILLING_HOLD
  • ACCOUNT_TOTAL_BUDGET_HOLD
  • ACCOUNT_END_DATE_HOLD
  • RESTRICTED_HOLD
  • INTERNAL_HOLD
status string, default="ACTIVE"
  • ACTIVE - Account is active; this is the default state
  • CANCELED - Account has been permanently canceled
  • DRAFT - Account is in draft status, meaning it's not yet fully set up and it is not serving
type string
  • BUSINESS – This is the only value allowed when creating accounts through the API.
  • ENTERPRISE – This value cannot be used to create accounts through the API and is reserved for accounts created by LinkedIn's internal ad operations systems.
test boolean, default="false" Flag showing whether this account is marked as a test account. An account can be marked as test only during creation. This is an immutable field.

CREATE

POST https://api.linkedin.com/v2/adAccountsV2

Parameters

Field Description Format Required
currency The account's ISO-4217 currency code. Default is "USD". string No
name A label for the account string Yes
notifiedOnCampaignOptimization Indicates if campaign contact is notified about campaign optimization opportunities. Default is false. boolean No
notifiedOnCreativeApproval Indicates if creative contact is notified when a creative has been reviewed and approved. Default is false. boolean No
notifiedOnCreativeRejection Indicates if creative contact is notified when a creative has been rejected due to content. Default is false. boolean No
notifiedOnEndOfCampaign Indicates if campaign contact is notified when an associated campaign has been completed. Default is false. boolean No
reference The entity on whose behalf the account advertises. Must either be in the format urn:li:person:{id} or urn:li:company:{id}. URN No
type The type of account. Must either be "PERSONAL" or "BUSINESS" string Yes

Sample Response

{
    "currency": "USD",
    "dailyBudget": {
        "amount": "15000",
        "currencyCode": "USD"
    },
    "name": "Test Advertiser Account",
    "notifiedOnCampaignOptimization": true,
    "notifiedOnCreativeApproval": true,
    "notifiedOnCreativeRejection": true,
    "notifiedOnEndOfCampaign": true,
    "reference": "urn:li:company:1000",
    "type": "BUSINESS"
}

GET

GET https://api.linkedin.com/v2/adAccountsV2/{account ID}

Parameters

Field Name Description
account ID Unique numerical identifier for the advertising account

Sample Response

{
    "test": false,
    "changeAuditStamps": {
        "created": {
            "actor": "urn:li:person:fGcyYDdglZ", 
            "time": 1449768717000
        }, 
        "lastModified": {
            "actor": "urn:li:unknown:0", 
            "time": 1477941718075
        }
    }, 
    "currency": "USD", 
    "id": 123456, 
    "name": "Company A", 
    "notifiedOnCampaignOptimization": true, 
    "notifiedOnCreativeApproval": true, 
    "notifiedOnCreativeRejection": true, 
    "notifiedOnEndOfCampaign": true, 
    "reference": "urn:li:organization:2414183", 
    "servingStatuses": [
        "RUNNABLE"
    ], 
    "status": "ACTIVE", 
    "totalBudget": {
        "amount": "1000", 
        "currencyCode": "USD"
    }, 
    "totalBudgetEndsAt": 1454683809000, 
    "type": "BUSINESS", 
    "version": {
        "versionTag": "10"
    }
}

SEARCH FINDER

GET https://api.linkedin.com/v2/adAccountsV2?q=search&search.{searchCriteria}.values[0]={searchValue}

Parameters

Field Name Description
search.status.values Searches for accounts with the provided status. The possible values are:
  • DRAFT
  • CANCELED
  • ACTIVE
search.reference.values Searches for accounts by reference
search.name.values Searches for an account by name
search.id.values Searches for an account by ID
search.type.values Searches for accounts by type. Possible values include:
  • BUSINESS
  • ENTERPRISE

Sample Response

{
    "elements": [
        {
            "changeAuditStamps": {
                "created": {
                    "actor": "urn:li:person:T1xE4HItnJ",
                    "time": 1479402003000
                },
                "lastModified": {
                    "actor": "urn:li:unknown:0",
                    "time": 1479402004534
                }
            },
            "currency": "USD",
            "id": 507404993,
            "name": "Dunder Mifflin Account",
            "notifiedOnCampaignOptimization": true,
            "notifiedOnCreativeApproval": true,
            "notifiedOnCreativeRejection": true,
            "notifiedOnEndOfCampaign": true,
            "reference": "urn:li:company:2414183",
            "servingStatuses": [
                "BILLING_HOLD"
            ],
            "status": "ACTIVE",
            "totalBudget": {
                "amount": "0",
                "currencyCode": "USD"
            },
            "totalBudgetEndsAt": 0,
            "type": "PERSONAL",
            "version": {
                "versionTag": "4"
            }
        }
    ],
    "paging": {
        "count": 2147483647,
        "links": [],
        "start": 0,
        "total": 56
    }
}

UPDATE

PUT https://api.linkedin.com/v2/adAccountsV2/{account ID}

Parameters

Field Description Format Required
name A label for the account string No
notifiedOnCampaignOptimization Indicates if campaign contact is notified about campaign optimization opportunities. Default is false. boolean No
notifiedOnCreativeApproval Indicates if creative contact is notified when a creative has been reviewed and approved. Default is false. boolean No
notifiedOnCreativeRejection Indicates if creative contact is notified when a creative has been rejected due to content. Default is false. boolean No
notifiedOnEndOfCampaign Indicates if campaign contact is notified when an associated campaign has been completed. Default is false. boolean No
status Status of the account string No