Introduction
This is the Matrix WebApi Reference documenting the public endpoints.
Version: 1.0.1
/CONTACTS
GET
Summary: Get entities from Contacts
HTTP Request
***GET*** /Contacts
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| $orderby | query | Order items by property values | No | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entities |
POST
Summary: Add new entity to Contacts
HTTP Request
***POST*** /Contacts
Responses
| Code | Description |
|---|---|
| 201 | Created entity |
/CONTACTS({CONTACTKEYNUMERIC})
GET
Summary: Get entity from Contacts by key
HTTP Request
***GET*** /Contacts({ContactKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of Contact | Yes | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entity |
PATCH
Summary: Update entity in Contacts
HTTP Request
***PATCH*** /Contacts({ContactKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of Contact | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
DELETE
Summary: Delete entity from Contacts
HTTP Request
***DELETE*** /Contacts({ContactKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of Contact | Yes | |
| If-Match | header | ETag | No |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/CONTACTS({CONTACTKEYNUMERIC})/PORTALCONTENTS
GET
Summary: Get PortalContents from Contacts
HTTP Request
***GET*** /Contacts({ContactKeyNumeric})/PortalContents
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of Contact | Yes | |
| $orderby | query | Order items by property values | No | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved navigation property |
/CONTACTS({CONTACTKEYNUMERIC})/PORTALCONTENTS(CONTACTKEYNUMERIC={CONTACTKEYNUMERIC1},LISTINGKEYNUMERIC={LISTINGKEYNUMERIC})
GET
Summary: Get PortalContents from Contacts
HTTP Request
***GET*** /Contacts({ContactKeyNumeric})/PortalContents(ContactKeyNumeric={ContactKeyNumeric1},ListingKeyNumeric={ListingKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of Contact | Yes | |
| ContactKeyNumeric1 | path | key: ContactKeyNumeric of ContactListing | Yes | |
| ListingKeyNumeric | path | key: ListingKeyNumeric of ContactListing | Yes | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved navigation property |
/CONTACTS({CONTACTKEYNUMERIC})/PORTALCONTENTS/$REF
GET
Summary: Get ref of PortalContents from Contacts
HTTP Request
***GET*** /Contacts({ContactKeyNumeric})/PortalContents/$ref
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of Contact | Yes | |
| $orderby | query | Order items by property values | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved navigation property links |
POST
Summary: Create new navigation property ref to PortalContents for Contacts
HTTP Request
***POST*** /Contacts({ContactKeyNumeric})/PortalContents/$ref
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of Contact | Yes |
Responses
| Code | Description |
|---|---|
| 201 | Created navigation property link. |
DELETE
Summary: Delete ref of navigation property PortalContents for Contacts
HTTP Request
***DELETE*** /Contacts({ContactKeyNumeric})/PortalContents/$ref
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of Contact | Yes | |
| If-Match | header | ETag | No | |
| @id | query | Delete Uri | No |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/EMAILHISTORY
GET
Summary: Get entities from EmailHistory
HTTP Request
***GET*** /EmailHistory
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| $orderby | query | Order items by property values | No | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entities |
POST
Summary: Add new entity to EmailHistory
HTTP Request
***POST*** /EmailHistory
Responses
| Code | Description |
|---|---|
| 201 | Created entity |
/EMAILHISTORY({EMAILHISTORYKEYNUMERIC})
GET
Summary: Get entity from EmailHistory by key
HTTP Request
***GET*** /EmailHistory({EmailHistoryKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| EmailHistoryKeyNumeric | path | key: EmailHistoryKeyNumeric of EmailHistory | Yes | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entity |
PATCH
Summary: Update entity in EmailHistory
HTTP Request
***PATCH*** /EmailHistory({EmailHistoryKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| EmailHistoryKeyNumeric | path | key: EmailHistoryKeyNumeric of EmailHistory | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
DELETE
Summary: Delete entity from EmailHistory
HTTP Request
***DELETE*** /EmailHistory({EmailHistoryKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| EmailHistoryKeyNumeric | path | key: EmailHistoryKeyNumeric of EmailHistory | Yes | |
| If-Match | header | ETag | No |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/GENERATEEDITLINK(RECORDKEY={RECORDKEY},CLASSNAME={CLASSNAME})
GET
Summary: Invoke functionImport GenerateEditLink
HTTP Request
***GET*** /GenerateEditLink(RecordKey={RecordKey},ClassName={ClassName})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| RecordKey | path | Yes | ||
| ClassName | path | Yes |
Responses
| Code | Description |
|---|---|
| 200 | Success |
/LISTS
GET
Summary: Get entities from Lists
HTTP Request
***GET*** /Lists
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| $orderby | query | Order items by property values | No | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entities |
POST
Summary: Add new entity to Lists
HTTP Request
***POST*** /Lists
Responses
| Code | Description |
|---|---|
| 201 | Created entity |
/LISTS(LISTKEY={LISTKEY},CLASSNAME={CLASSNAME})
GET
Summary: Get entity from Lists by key
HTTP Request
***GET*** /Lists(ListKey={ListKey},ClassName={ClassName})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ListKey | path | key: ListKey of List | Yes | |
| ClassName | path | key: ClassName of List | Yes | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entity |
PATCH
Summary: Update entity in Lists
HTTP Request
***PATCH*** /Lists(ListKey={ListKey},ClassName={ClassName})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ListKey | path | key: ListKey of List | Yes | |
| ClassName | path | key: ClassName of List | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
DELETE
Summary: Delete entity from Lists
HTTP Request
***DELETE*** /Lists(ListKey={ListKey},ClassName={ClassName})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ListKey | path | key: ListKey of List | Yes | |
| ClassName | path | key: ClassName of List | Yes | |
| If-Match | header | ETag | No |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/MATRIXDATACHANGES
GET
Summary: Get entities from MatrixDataChanges
HTTP Request
***GET*** /MatrixDataChanges
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| $orderby | query | Order items by property values | No | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entities |
POST
Summary: Add new entity to MatrixDataChanges
HTTP Request
***POST*** /MatrixDataChanges
Responses
| Code | Description |
|---|---|
| 201 | Created entity |
/MATRIXDATACHANGES(RESOURCEKEY={RESOURCEKEY},RESOURCETYPE={RESOURCETYPE})
GET
Summary: Get entity from MatrixDataChanges by key
HTTP Request
***GET*** /MatrixDataChanges(ResourceKey={ResourceKey},ResourceType={ResourceType})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ResourceKey | path | key: ResourceKey of MatrixDataChange | Yes | |
| ResourceType | path | key: ResourceType of MatrixDataChange | Yes | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entity |
PATCH
Summary: Update entity in MatrixDataChanges
HTTP Request
***PATCH*** /MatrixDataChanges(ResourceKey={ResourceKey},ResourceType={ResourceType})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ResourceKey | path | key: ResourceKey of MatrixDataChange | Yes | |
| ResourceType | path | key: ResourceType of MatrixDataChange | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
DELETE
Summary: Delete entity from MatrixDataChanges
HTTP Request
***DELETE*** /MatrixDataChanges(ResourceKey={ResourceKey},ResourceType={ResourceType})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ResourceKey | path | key: ResourceKey of MatrixDataChange | Yes | |
| ResourceType | path | key: ResourceType of MatrixDataChange | Yes | |
| If-Match | header | ETag | No |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/PORTALCONTENTS
GET
Summary: Get entities from PortalContents
HTTP Request
***GET*** /PortalContents
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| $orderby | query | Order items by property values | No | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entities |
POST
Summary: Add new entity to PortalContents
HTTP Request
***POST*** /PortalContents
Responses
| Code | Description |
|---|---|
| 201 | Created entity |
/PORTALCONTENTS(CONTACTKEYNUMERIC={CONTACTKEYNUMERIC},LISTINGKEYNUMERIC={LISTINGKEYNUMERIC})
GET
Summary: Get entity from PortalContents by key
HTTP Request
***GET*** /PortalContents(ContactKeyNumeric={ContactKeyNumeric},ListingKeyNumeric={ListingKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of ContactListing | Yes | |
| ListingKeyNumeric | path | key: ListingKeyNumeric of ContactListing | Yes | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entity |
PATCH
Summary: Update entity in PortalContents
HTTP Request
***PATCH*** /PortalContents(ContactKeyNumeric={ContactKeyNumeric},ListingKeyNumeric={ListingKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of ContactListing | Yes | |
| ListingKeyNumeric | path | key: ListingKeyNumeric of ContactListing | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
DELETE
Summary: Delete entity from PortalContents
HTTP Request
***DELETE*** /PortalContents(ContactKeyNumeric={ContactKeyNumeric},ListingKeyNumeric={ListingKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of ContactListing | Yes | |
| ListingKeyNumeric | path | key: ListingKeyNumeric of ContactListing | Yes | |
| If-Match | header | ETag | No |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/PORTALCONTENTS(CONTACTKEYNUMERIC={CONTACTKEYNUMERIC},LISTINGKEYNUMERIC={LISTINGKEYNUMERIC})/DEFAULT.ADDLISTINGNOTE
POST
Summary: Invoke action AddListingNote
HTTP Request
***POST*** /PortalContents(ContactKeyNumeric={ContactKeyNumeric},ListingKeyNumeric={ListingKeyNumeric})/Default.AddListingNote
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of ContactListing | Yes | |
| ListingKeyNumeric | path | key: ListingKeyNumeric of ContactListing | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/PORTALCONTENTS(CONTACTKEYNUMERIC={CONTACTKEYNUMERIC},LISTINGKEYNUMERIC={LISTINGKEYNUMERIC})/DEFAULT.MARKASVIEWED
POST
Summary: Invoke action MarkAsViewed
HTTP Request
***POST*** /PortalContents(ContactKeyNumeric={ContactKeyNumeric},ListingKeyNumeric={ListingKeyNumeric})/Default.MarkAsViewed
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of ContactListing | Yes | |
| ListingKeyNumeric | path | key: ListingKeyNumeric of ContactListing | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/PORTALCONTENTS(CONTACTKEYNUMERIC={CONTACTKEYNUMERIC},LISTINGKEYNUMERIC={LISTINGKEYNUMERIC})/DEFAULT.SETLISTINGPREFERENCE
POST
Summary: Invoke action SetListingPreference
HTTP Request
***POST*** /PortalContents(ContactKeyNumeric={ContactKeyNumeric},ListingKeyNumeric={ListingKeyNumeric})/Default.SetListingPreference
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| ContactKeyNumeric | path | key: ContactKeyNumeric of ContactListing | Yes | |
| ListingKeyNumeric | path | key: ListingKeyNumeric of ContactListing | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/SAVEDSEARCHES
GET
Summary: Get entities from SavedSearches
HTTP Request
***GET*** /SavedSearches
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| $orderby | query | Order items by property values | No | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entities |
POST
Summary: Add new entity to SavedSearches
HTTP Request
***POST*** /SavedSearches
Responses
| Code | Description |
|---|---|
| 201 | Created entity |
/SAVEDSEARCHES({SAVEDSEARCHKEYNUMERIC})
GET
Summary: Get entity from SavedSearches by key
HTTP Request
***GET*** /SavedSearches({SavedSearchKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| SavedSearchKeyNumeric | path | key: SavedSearchKeyNumeric of SavedSearch | Yes | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved entity |
PATCH
Summary: Update entity in SavedSearches
HTTP Request
***PATCH*** /SavedSearches({SavedSearchKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| SavedSearchKeyNumeric | path | key: SavedSearchKeyNumeric of SavedSearch | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
DELETE
Summary: Delete entity from SavedSearches
HTTP Request
***DELETE*** /SavedSearches({SavedSearchKeyNumeric})
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| SavedSearchKeyNumeric | path | key: SavedSearchKeyNumeric of SavedSearch | Yes | |
| If-Match | header | ETag | No |
Responses
| Code | Description |
|---|---|
| 204 | Success |
/SAVEDSEARCHES({SAVEDSEARCHKEYNUMERIC})/DEFAULT.GETSAVEDSEARCHLISTINGIDS()
GET
Summary: Invoke function GetSavedSearchListingIDs
HTTP Request
***GET*** /SavedSearches({SavedSearchKeyNumeric})/Default.GetSavedSearchListingIDs()
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| SavedSearchKeyNumeric | path | key: SavedSearchKeyNumeric of SavedSearch | Yes |
Responses
| Code | Description |
|---|---|
| 200 | Success |
/SAVEDSEARCHES({SAVEDSEARCHKEYNUMERIC})/PROSPECTING
GET
Summary: Get Prospecting from SavedSearches
HTTP Request
***GET*** /SavedSearches({SavedSearchKeyNumeric})/Prospecting
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| SavedSearchKeyNumeric | path | key: SavedSearchKeyNumeric of SavedSearch | Yes | |
| $select | query | Select properties to be returned | No | |
| $expand | query | Expand related entities | No |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved navigation property |
/SAVEDSEARCHES({SAVEDSEARCHKEYNUMERIC})/PROSPECTING/$REF
GET
Summary: Get ref of Prospecting from SavedSearches
HTTP Request
***GET*** /SavedSearches({SavedSearchKeyNumeric})/Prospecting/$ref
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| SavedSearchKeyNumeric | path | key: SavedSearchKeyNumeric of SavedSearch | Yes |
Responses
| Code | Description |
|---|---|
| 200 | Retrieved navigation property link |
PATCH
Summary: Update the ref of navigation property Prospecting in SavedSearches
HTTP Request
***PATCH*** /SavedSearches({SavedSearchKeyNumeric})/Prospecting/$ref
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| SavedSearchKeyNumeric | path | key: SavedSearchKeyNumeric of SavedSearch | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success |
DELETE
Summary: Delete ref of navigation property Prospecting for SavedSearches
HTTP Request
***DELETE*** /SavedSearches({SavedSearchKeyNumeric})/Prospecting/$ref
Parameters
| Name | Located in | Description | Required | Type |
|---|---|---|---|---|
| SavedSearchKeyNumeric | path | key: SavedSearchKeyNumeric of SavedSearch | Yes | |
| If-Match | header | ETag | No |
Responses
| Code | Description |
|---|---|
| 204 | Success |