Account Properties are unique branding details for an Account. This is a collection settings that control some functionalities. Changing an Account Property may also affect the same Account Property of its sub accounts that has not done any overrides to the Account Property. Once a sub-account has done an edit to an Account Property, this will create an override and will no longer be dependent on the parent Account. By default, a User who does not have a Permission of PERM_IS_VT_ADMIN cannot retrieve system Account Properties in an unqualified GET. System Account Properties can only be accessed if their exact name is specified.
Fields
| Tag | Data Type | Required | Description |
| accountId | Long | No | The id of the Account that owns this record. |
| id | Auto-incremented Long | Auto | Unique Identifier. |
| isParent | Boolean | Auto | Indicates if the Account Property is from the current Account or inherited from a parent Account’s Account Property. |
| isSystem | Boolean | No | Indicates if the Account Property is a system property or not. Only Users with a Permission of PERM_IS_VT_ADMIN can read, create and update system properties. |
| lastChangedDate | Text | Auto | Auto-generated timestamp of the last change made to this record. Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z) |
| name | Character (255) | Yes | The name of the Account Property. |
| value | Text (unlimited) | Yes | The value of the Account Property. |
Read
| API PATH: | /api/v2/accountProperties |
| METHOD: | GET |
| PARAMETERS: | name – Retrieves the matching record with the specified name. (e.g. name=hos.carrier, all names by default) from-change-timestamp – Retrieves records modified since the timestamp supplied (e.g. from-change-timestamp=2018-06-11T12:00:00.000Z, all timestamps by default) to-change-timestamp – Retrieves records modified before the timestamp supplied (e.g. to-change-timestamp=2018-06-11T12:00:00.000Z, REQUIRES from-change-timestamp) offset – Retrieves matching records after an offset value (e.g. offset=2, zero offset by default) limit – Retrieves a number of records per page specified by the value (e.g. limit=10, all records by default) |
| SORTING: | sort=id – Sort records by their id field in ascending order (DEFAULT) sort=-id – Sort records by their id field in descending order sort=name – Sort records by their name field in ascending order sort=-name – Sort records by their name field in descending order sort=last-changed-date– Sort records by their last change date field in ascending order sort=-last-changed-date– Sort records by their last change date field in descending order |
| QUERY STRING EXAMPLES: | Get the account property with the specified id: api/v2/accountProperties/225130 Get the account property with the specific name: ?name=hos.carrier Get two account properties of the current account with an offset of 1 : ?offset=1&limit=2 Get all account properties of the current account sorted by names alphabetically: ?sort=name |
| EXAMPLE RESPONSE: |
[
{
"name": "hos.carrier",
"value": "CARRIER",
"isParent": true,
"isSystem": false,
"id": 225130,
"lastChangedDate": "2018-06-11T12:00:00.000Z"
}
]
|
Create
| API PATH: | /api/v2/accountProperties |
| METHOD: | POST |
| EXAMPLE REQUEST: |
[
{
"name": "custom.prop.one",
"value": "Custom Property"
}
]
|
| EXAMPLE RESPONSE: |
[
{
"name": "custom.prop.one",
"value": "Custom Property",
"isParent": false,
"isSystem": false,
"id": 225131,
"lastChangedDate": "2018-06-11T12:00:00.000Z"
}
]
|
Update
| API PATH: | /api/v2/accountProperties |
| METHOD: | PUT |
| EXAMPLE REQUEST: |
[
{
"name": "custom.prop.one",
"value": "Custom Property - EDIT",
"id": 225131,
}
]
|
| EXAMPLE RESPONSE: |
[
{
"name": "custom.prop.one",
"value": "Custom Property - EDIT",
"isParent": false,
"isSystem": false,
"id": 225131,
"lastChangedDate": "2018-06-11T12:00:00.000Z"
}
]
|