Account Object – API Help Center

Related Entities

Endpoint Using the Account Object

Account Resource

Account Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name	DESCRIPTION	TYPE	REQUIRED	NOTES
type	Type of entity.	String	Required	Account
id	ID of account. read-only parameter, auto-generated	Integer	Read-only
relationsBag	Internal.	relationsBag Object	Internal
version	Internal.	Internal	Internal
createdBy	Internal.	Internal	Internal
createdByName	Internal.	Internal	Internal
createdByAccount	Internal.	Internal	Internal
createdByAccountName	Internal.	Internal	Internal
createdOn	Internal.	Internal	Internal
lastUpdatedBy	Internal.	Internal	Internal
lastUpdatedByName	Internal.	Internal	Internal
lastUpdatedByAccount	Internal.	Internal	Internal
lastUpdatedByAccountName	Internal.	Internal	Internal
lastUpdateOn	Internal.	Internal	Internal
name	Name of account.	String	Required
status	Internal.	Internal	Internal
adminSettings	Internal.	Internal	Internal
billingSettings	Internal.	Internal	Internal
analyticsSettings	Internal.	Internal	Internal
office	Internal.	Internal	Internal
assetsAccountSettings	Internal.	Internal	Internal
customFields	Internal.	Internal	Internal
currency	Internal.	Internal	Internal
internal	Internal.	Internal	Internal
legacyRocketfuelAccount	Internal.	Internal	Internal
partnerAccounts	Internal.	Internal	Internal
expandableAccounts	Internal.	Internal	Internal
accountTypes	Internal.	Internal	Internal
accessLevel	Internal.	Internal	Internal
upgraded	Internal.	Internal	Internal
clientMetricCollector	Internal.	Internal	Internal
note	Internal.	Internal	Internal
x_api_key	Internal.	Internal	Internal
cookieSync	Internal.	Internal	Internal
systemIntegrations	Internal.	Internal	Internal
systemLanguage	Internal.	Internal	Internal
accountAPISettings	Internal.	Internal	Internal

Object JSON Example

{
  "result": {
    "type": "Account",
    "id": 1083742600,
    "relationsBag": {
      "parents": {
        "account": {
          "id": 1083742600,
          "name": null,
          "internal": null
        },
        "advertiser": null,
        "brand": null,
        "campaign": null,
        "site": null
      },
      "children": {
        "advertisers": {
          "count": 7
        },
        "brands": {
          "count": 9
        },
        "campaigns": {
          "count": 7
        },
        "users": {
          "count": 4
        }
      },
      "creativeAccountContact": false
    },
    "version": 1539011492099850200,
    "createdBy": null,
    "createdByName": "User",
    "createdByAccount": 1073741800,
    "createdByAccountName": "Account",
    "createdOn": 1519724752812,
    "lastUpdatedBy": 1073741800,
    "lastUpdatedByName": "User",
    "lastUpdatedByAccount": 1073741800,
    "lastUpdatedByAccountName": "Account",
    "lastUpdateOn": 1539011492097,
    "name": "0316C46fHy111333",
    "status": "Enabled",
    "adminSettings": {
      "type": "AdminSettings",
      "regionalSettings": {
        "type": "RegionalSettings",
        "defaultTimeZone": "GMT_Plus_04",
        "market": {
          "type": "Market",
          "id": 4,
          "name": "Pacific"
        }
      },
      "defaultContacts": {
        "type": "DefaultContacts",
        "relationsBag": null,
        "sizmekContacts": [
          {
            "type": "DefaultSizmekContact",
            "id": 16142220918700,
            "relationsBag": null,
            "contactId": 1073741800,
            "name": "FirstSizmekUser",
            "campaignRole": "ClientServicesManager"
          },
          {
            "type": "DefaultSizmekContact",
            "id": 16142220918700,
            "relationsBag": null,
            "contactId": 1073741800,
            "name": "FirstSizmekUser",
            "campaignRole": "SalesManager"
          }
        ],
        "campaignManagerContacts": [],
        "creativeManagerContacts": [],
        "creativeAccounts": []
      },
      "thirdPartyTracking": "CustomParameters",
      "servingSettings": {
        "type": "ServingSettings",
        "collectBelowTheFold": true,
        "dfCollectionID": 1945764100,
        "pathLength": 0,
        "visibilityMinimumSurface": -950344327,
        "visibilityMinimumDuration": 957968542,
        "agencyVisibilityMinimumDuration": 1467355797,
        "agencyVisibilityMinimumSurface": -845312023,
        "adChoicesCertificationProgramID": -1899896315,
        "adChoicesClickthroughURL": "wPcwebRlQ9",
        "disableCookie": true,
        "saveAdCookie": true,
        "retargetingCookieWindow": -2026386520,
        "deviceIntelligenceTypeId": -1244854494
      },
      "campaignSettings": {
        "type": "CampaignSettings",
        "hardStopMethod": "KEEP_SERVING_AS_USUAL",
        "creativeManagerAccess": true,
        "traffickingMode": "AdvancedMode",
        "targetAudiencePriorityPolicy": "Server"
      },
      "privacy": {
        "type": "Privacy",
        "adMarker": {
          "includeInAllAds": false,
          "regulationProgram": "IAB_EU",
          "markerClickthroughURL": null
        },
        "disableCookies": false
      },
      "video": {
        "type": "Video",
        "autoTranscode": true
      }
    },
    "billingSettings": {
      "type": "BillingSettings",
      "city": "h6IGmR8yq7",
      "zipCode": "sOz8yU1uhl",
      "vat_tin": "UWbyoWLUCL",
      "billingUserId": "1083742600",
      "billingUserName": "9hCRP04bjL",
      "billingAddress": "PvNzFczGVm",
      "country": {
        "type": "Country",
        "countryCode": "AR",
        "name": "Argentina",
        "state": {
          "type": "State",
          "stateCode": null,
          "name": null
        }
      },
      "billingAccountName": "ixcki67zqS"
    },
    "analyticsSettings": {
      "type": "AnalyticsSettings",
      "ignoreOverDelivery": true,
      "verificationMode": "NO_COLLECTION",
      "viewabilityThreshold": {
        "type": "ViewabilityThreshold",
        "minimumSurface": 50,
        "minimumDuration": 1
      },
      "instreamViewabilityThreshold": {
        "type": "ViewabilityThreshold",
        "minimumSurface": 50,
        "minimumDuration": 2
      }
    },
    "office": {
      "type": "Office",
      "id": 59,
      "name": "Australia",
      "marketId": 4,
      "defaultCurrencyId": 2
    },
    "assetsAccountSettings": null,
    "customFields": null,
    "currency": {
      "type": "Currency",
      "id": 2,
      "name": "Australian Dollar",
      "currencyLetters": "AUD"
    },
    "internal": true,
    "legacyRocketfuelAccount": {
      "type": "LegacyRocketfuelAccount",
      "rocketfuelId": "HVjSpZT6_D",
      "salesforceId": "zNxC4dcM33"
    },
    "partnerAccounts": null,
    "expandableAccounts": [],
    "accountTypes": {
      "type": "AccountTypes",
      "campaignManager": true,
      "creativeManager": true,
      "payingAccount": true
    },
    "accessLevel": "Full",
    "upgraded": "None",
    "clientMetricCollector": true,
    "note": "wF6DUGWtzA",
    "x_api_key": null,
    "cookieSync": null,
    "systemIntegrations": null,
    "systemLanguage": "English",
    "accountAPISettings": {
      "type": "AccountAPISettings",
      "isSignedAPITermsAndConditions": false
    }
  }
}

Related Entities

Endpoint Using the Account Object

Account Object Definition

Note

Object JSON Example

Comments