8 API Reference‎ > ‎Resources‎ > ‎

Account

NOTE: Used only in Distribution API.

Account represents an account that can be used in orders and reservations. It is primarily used by platforms that host different publishers and need to differ one publisher from another. In such cases a platform has a single API key to access The Adility API and uses accounts to link reservations and orders to publishers.

Attributes
  • id string.
  • name string. (renamed from title)
  • website_url string.
  • status string. pending, active, cancelled

Data Examples


JSON

{
    "id": "",
    "name": "Pets Super Magazine, Inc.",
    "website_url": "http://petsupermagazine.com/",
    "status": "active"
}

XML

<account>
    <id>speru293erfweyrf02yer0fwyr8</id>
    <name>Pets Super Magazine, Inc.</name>
    <website_url>http://petsupermagazine.com/</website_url>
    <status>active</status>
</account>

Actions

You can create, update and delete accounts.

Create Account

Some text...

POST /accounts

JSON

Request

{     "account": {         "name": "mySimon, Inc.",        
        "website_url": "http://dailydeals.mysimon.com"     } }

Response

HTTP/1.1 200 OK {     "status": "OK",     "account": {         "id": "erfu2098fu2uer02fu0reu2290e8fr",         "name": "mySimon, Inc.",         "website_url": "http://dailydeals.mysimon.com",         "status": "pending"     } }

XML

Request

<?xml version="1.0" encoding="UTF-8"?>
<account> 
    <name>mySimon, Inc.</name>
    <website_url>http://dailydeals.mysimon.com</website_url>
</account>

Response

HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <response>     <status>OK</status>     <account>         <id>3iery928yrefwy0e827y9erbyq</id>         <name>mySimon, Inc.</name>
        <website_url>http://dailydeals.mysimon.com</website_url>
        <status>pending</status>     </account> </response>

Update Account


PUT /accounts/:id


Query Accounts


GET /accounts


Get Account Details


GET /accounts/:id

Delete Account

DELETE /accounts/:id


Comments