GitBook: [master] 52 pages modified

Author: iVvy

README.md

@@ -1,4 +1,11 @@
-# Initial page
+---
+description: >-
+  With iVvy's robust API, you can connect all your core business apps to meet
+  your unique needs. Browse through the topics below to find exactly what you're
+  looking for or check our Getting Started guid
+---
+
+# API Documentation
 
 
 

SUMMARY.md

@@ -1,6 +1,6 @@
 # Table of contents
 
-* [Initial page](README.md)
+* [API Documentation](README.md)
 * [Home](home.md)
 * [Getting Started](getting-started/README.md)
   * [Introduction](getting-started/introduction.md)

account/README.md

@@ -1,10 +1,8 @@
 # Account
 
-### Namespace
+## Namespace
 
 ```text
 account
 ```
 
-
-

account/add-or-update-cost-center.md

@@ -1,14 +1,14 @@
 # Add or Update Cost Center
 
-### Description
+## Description
 
 Add or update cost center details to the account. The cost center name and code are required.
 
-### Api Url
+## Api Url
 
 `[PlatformAddress]/api/1.0/account?action=addOrUpdateCostCenter`
 
-### Parameters
+## Parameters
 
 | Property | Description | Required | Type |
 | --- | --- | --- | --- |
@@ -17,21 +17,21 @@ Add or update cost center details to the account. The cost center name and code
 | code | The code of the cost center | Required | string |
 | description | The complete description of the cost center |  | string |
 
-### Returns
+## Returns
 
 | Property | Description |
 | --- | --- |
 | success | Whether or not the cost center was added to the account |
 | id | The unique identifier of the cost center |
 
-### Throws
+## Throws
 
 | Code | Description |
 | --- | --- |
 | Specific Code: 24150 | Account does not exist |
 | Specific Code: 24150 | The cost centers details are invalid |
 
-### Example Request
+## Example Request
 
 `Example: Add a cost center to an account`
 
@@ -43,7 +43,7 @@ Add or update cost center details to the account. The cost center name and code
 }
 ```
 
-### Example Response
+## Example Response
 
 ```javascript
 {

account/get-cost-center-list.md

@@ -1,14 +1,14 @@
 # Get Cost Center List
 
-### Description
+## Description
 
 Fetches the list of cost centers in the account. No request params required.
 
-### Api Url
+## Api Url
 
 `[PlatformAddress]/api/1.0/account?action=getCostCenterList`
 
-### Returns
+## Returns
 
 | Property | Description |
 | --- | --- |
@@ -18,13 +18,13 @@ Fetches the list of cost centers in the account. No request params required.
 | description | The complete description of the cost center |
 | defaultType | Set if one of the default cost centers |
 
-### Throws
+## Throws
 
 | Code | Description |
 | --- | --- |
 | Specific Code: 24150 | Account does not exist |
 
-### Example Response
+## Example Response
 
 `Example: get cost center list of the account`
 

account/get-email-log-list.md

@@ -1,14 +1,14 @@
 # Get Email Log List
 
-### Description
+## Description
 
 The result from this call will be a [collection](../interpreting-the-response/collections.md) of all the events the user has access to. This call also accepts the [pagination](../interpreting-the-response/pagination.md) and [filter](../interpreting-the-response/filtering.md) properties.
 
-### Api Url
+## Api Url
 
 `[PlatformAddress]/api/1.0/account?action=getEmailLogList`
 
-### Returns
+## Returns
 
 | Property | Description |
 | --- | --- |
@@ -27,13 +27,13 @@ The result from this call will be a [collection](../interpreting-the-response/co
 | sentTime | The sent time of the email in UTC |
 | success | Whether or not email has been sent or not |
 
-### Throws
+## Throws
 
 | Code | Description |
 | --- | --- |
 | Specific Code: 24151 | Account does not exist |
 
-### Example Response
+## Example Response
 
 `Example: Get a specific account’s Email Logs List`
 
@@ -66,7 +66,7 @@ The result from this call will be a [collection](../interpreting-the-response/co
 }
 ```
 
-### refType:
+## refType:
 
 One of the following values:
 
@@ -86,7 +86,7 @@ One of the following values:
 * 13 = Company
 * 14 = Floor Plan
 
-### type:
+## type:
 
 One of the following values:
 

batch/repost.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-The repost action takes the asyncId as a parameter and returns the success of the call. 
+The repost action takes the asyncId as a parameter and returns the success of the call.
 
 {% hint style="info" %}
 Note a success of true does not mean the callback will be hit immediately.

contact/add-contacts-to-subscription-group.md

@@ -1,21 +1,21 @@
 # Add Contacts To Subscription Group
 
-### Description
+## Description
 
 Add contact details to subscription group.
 
-### API URL
+## API URL
 
 `[PlatformAddress]/api/1.0/contact?action=addContactsToSubscriptionGroup`
 
-### Parameters
+## Parameters
 
 | Property | Description | Required | Type |
 | --- | --- | --- | --- |
 | contacts | The contact identifiers to subscribe to the group | Required | integer \(This is an array of contact identifiers\) |
 | group | The subscription group identifier to add the contacts to | Required | integer |
 
-### Returns
+## Returns
 
 An array of objects with the following properties
 
@@ -24,9 +24,9 @@ An array of objects with the following properties
 | contactId | The contact this result is for |
 | status | If the contact was added to the group or not |
 
-### `Adds a number of contacts to a subscription group.`
+## `Adds a number of contacts to a subscription group.`
 
-### Example Request
+## Example Request
 
 Add 4 contacts to subscription group 2481
 
@@ -42,7 +42,7 @@ Add 4 contacts to subscription group 2481
 }
 ```
 
-### Example Response
+## Example Response
 
 ```javascript
 [

contact/add-or-update-company.md

@@ -1,14 +1,14 @@
 # Add or Update Company
 
-### Description
+## Description
 
 Add or update company detail.
 
-### API URL
+## API URL
 
 `[PlatformAddress]/api/1.0/contact?action=addOrUpdateCompany`
 
-### Parameters
+## Parameters
 
 | Property | Description | Required | Type |
 | --- | --- | --- | --- |
@@ -23,7 +23,7 @@ Add or update company detail.
 | email | The company's email address |  |  |
 | address | The company’s address. This is an an object with the [keys](add-or-update-company.md#keys) |  |  |
 
-### Keys
+## Keys
 
 | keys |
 | --- |
@@ -36,7 +36,7 @@ Add or update company detail.
 | countryCode \(e.g: AU\) |
 | postalCode |
 
-### Returns
+## Returns
 
 | Property | Description |
 | --- | --- |
@@ -64,9 +64,9 @@ The properties of the company currently supported are:
 * address
   * This is an object
 
-### `Adding a company`
+## `Adding a company`
 
-### Example Request
+## Example Request
 
 ```javascript
 {
@@ -83,7 +83,7 @@ The properties of the company currently supported are:
 }
 ```
 
-### Example Response
+## Example Response
 
 ```javascript
 {
@@ -92,9 +92,9 @@ The properties of the company currently supported are:
 }
 ```
 
-### `Updating a company`
+## `Updating a company`
 
-### Example Request
+## Example Request
 
 ```javascript
 {
@@ -110,7 +110,7 @@ The properties of the company currently supported are:
 }
 ```
 
-### Example Response
+## Example Response
 
 ```javascript
 {

contact/add-or-update-contact.md

@@ -1,14 +1,14 @@
 # Add or Update Contact
 
-### Description
+## Description
 
 Add or update contact details.
 
-### API URL
+## API URL
 
 `[PlatformAddress]/api/1.0/contact?action=addOrUpdateContact`
 
-### Parameters
+## Parameters
 
 | Property | Description | Required | Type |
 | --- | --- | --- | --- |
@@ -21,7 +21,7 @@ Add or update contact details.
 | customFields | The array of custom fields to set on the contact | Each field will be validated depending on the type of field that is being set. |  |
 | companies | The array of companies to set the contact. | Each values will be validated depending on the type of field as well as it will verify that the given company is exist or not. |  |
 
-### Returns
+## Returns
 
 | Property | Description |
 | --- | --- |
@@ -49,9 +49,9 @@ The properties of the contact currently supported are:
 * Companies
   * This is an array of companies Ids
 
-### `Adding a contact`
+## `Adding a contact`
 
-### Example Request
+## Example Request
 
 ```javascript
 {
@@ -75,17 +75,17 @@ The properties of the contact currently supported are:
 }
 ```
 
-### Example Response
+## Example Response
 
 ```javascript
 {
   "id":33884
 }
 ```
 
-### `Updating a contact`
+## `Updating a contact`
 
-### Example Request
+## Example Request
 
 `Note : the groups will be set to only group 10, destroying the existing value`
 
@@ -99,7 +99,7 @@ The properties of the contact currently supported are:
 }
 ```
 
-### Example Response
+## Example Response
 
 ```javascript
 {