Version 1.0
Connector Overview: This page documents all 650 actions for the Impartnerconnector v1.0.
Country Member API (3)
POST Gets a list of Countries corresponding to the given data fields.
/prm/api/objects/v1/Country
Retrieve a list of countries matching the field values provided in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Countries corresponding to the given parameters.
/prm/api/objects/v1/Country
Retrieve a list of countries based on the supplied query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Country by id.
/prm/api/objects/v1/Country/{id}
Retrieve details for a specific country by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
CrmEnvironment Admin API (4)
DELETE Deletes a single CRM Environment by id.
/api/objects/v1/CrmEnvironment/{id}
Permanently remove a single CRM environment using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many CRM Environments by id.
/api/objects/v1/CrmEnvironment
Permanently remove multiple CRM environments by specifying their identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single CRM Environment based on the specified view model.
/api/objects/v1/CrmEnvironment/{id}
Apply partial updates to an existing CRM environment record using its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many CRM Environments based on the specified view models.
/api/objects/v1/CrmEnvironment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
CrmEnvironment Member API (4)
DELETE Deletes a single CRM Environment by id.
/prm/api/objects/v1/CrmEnvironment/{id}
Permanently remove a single CRM environment by its unique identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many CRM Environments by id.
/prm/api/objects/v1/CrmEnvironment
Permanently remove multiple CRM environments by their identifiers via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single CRM Environment based on the specified view model.
/prm/api/objects/v1/CrmEnvironment/{id}
Apply partial updates to an existing CRM environment record by its identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many CRM Environments based on the specified view models.
/prm/api/objects/v1/CrmEnvironment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
CustomField Admin API
GET Gets custom fields by object API name (or 3 character RvObjectType Id).
/api/objects/v1/CustomField/byObject/{objectName}
Retrieve the custom fields configured for a specified object API name or three-character object type identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object API name (or 3 character RvObjectType Id) of custom field OwnerType |
|
|
Specifies the target API version for processing the request. |
|
|
The response format expected from the API (e.g. application/json). |
CustomField Member API
GET Gets custom fields by object API name (or 3 character RvObjectType Id).
/prm/api/objects/v1/CustomField/byObject/{objectName}
Retrieve custom fields for a specific object name or three-character object type identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object API name (or 3 character RvObjectType Id) of custom field OwnerType |
|
|
Specifies the target API version for processing the request. |
|
|
The response format expected from the API (e.g. application/json). |
CustomObjectType Admin API (3)
POST Gets a list of Custom Object Types corresponding to the given data fields.
/api/objects/v1/CustomObjectType
Retrieve a list of custom object types matching the field values submitted in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Custom Object Types corresponding to the given parameters.
/api/objects/v1/CustomObjectType
Retrieve a list of custom object types matching the provided query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Custom Object Type by id.
/api/objects/v1/CustomObjectType/{id}
Retrieve details for a specific custom object type by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
CustomObjectType Member API (3)
POST Gets a list of Custom Object Types corresponding to the given data fields.
/prm/api/objects/v1/CustomObjectType
Retrieve a list of custom object types matching the field criteria provided in the request body via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Custom Object Types corresponding to the given parameters.
/prm/api/objects/v1/CustomObjectType
Retrieve a list of custom object types using query parameters via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Custom Object Type by id.
/prm/api/objects/v1/CustomObjectType/{id}
Retrieve details for a single custom object type by its unique identifier via the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Customer Admin API (8)
PUT Adds a single or many Customers based on the specified view model(s).
/api/objects/v1/Customer
Create or replace one or more customer records based on the provided view models.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Customer by id.
/api/objects/v1/Customer/{id}
Permanently remove a single customer record by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Customers by id.
/api/objects/v1/Customer
Permanently remove multiple customer records by providing their identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Customers corresponding to the given data fields.
/api/objects/v1/Customer
Retrieve a list of customers based on filter criteria provided in the request body using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Customers corresponding to the given parameters.
/api/objects/v1/Customer
Retrieve a list of customers using query parameters with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Customer by id.
/api/objects/v1/Customer/{id}
Retrieve details for a specific customer by ID using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Customer based on the specified view model.
/api/objects/v1/Customer/{id}
Update specific fields of an existing customer by ID using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Customers based on the specified view models.
/api/objects/v1/Customer
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Customer Member API (8)
PUT Adds a single or many Customers based on the specified view model(s).
/prm/api/objects/v1/Customer
Create or update one or more customer records as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Customer by id.
/prm/api/objects/v1/Customer/{id}
Delete a single customer record by its ID as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Customers by id.
/prm/api/objects/v1/Customer
Delete multiple customer records by their IDs in a single request as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Customers corresponding to the given data fields.
/prm/api/objects/v1/Customer
Retrieve a list of customers matching data criteria sent in the request body as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Customers corresponding to the given parameters.
/prm/api/objects/v1/Customer
Retrieve a list of customers matching query parameters as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Customer by id.
/prm/api/objects/v1/Customer/{id}
Retrieve details for a single customer by ID as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Customer based on the specified view model.
/prm/api/objects/v1/Customer/{id}
Update specific fields of an existing customer by ID as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Customers based on the specified view models.
/prm/api/objects/v1/Customer
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
CustomerAttachment Admin API (8)
PUT Adds a single or many Customer Attachments based on the specified view model(s).
/api/objects/v1/CustomerAttachment
Create or replace one or more customer attachments using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Customer Attachment by id.
/api/objects/v1/CustomerAttachment/{id}
Delete a specific customer attachment by ID using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Customer Attachments by id.
/api/objects/v1/CustomerAttachment
Delete multiple customer attachments by their IDs using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Customer Attachments corresponding to the given data fields.
/api/objects/v1/CustomerAttachment
Retrieve a list of customer attachments matching criteria supplied in the request body using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Customer Attachments corresponding to the given parameters.
/api/objects/v1/CustomerAttachment
Retrieve a list of customer attachments matching query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Customer Attachment by id.
/api/objects/v1/CustomerAttachment/{id}
Retrieve details of a specific customer attachment by ID using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Customer Attachment based on the specified view model.
/api/objects/v1/CustomerAttachment/{id}
Update specific fields of a customer attachment by ID using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Customer Attachments based on the specified view models.
/api/objects/v1/CustomerAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
CustomerAttachment Member API (8)
PUT Adds a single or many Customer Attachments based on the specified view model(s).
/prm/api/objects/v1/CustomerAttachment
Create or replace one or more customer attachments as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Customer Attachment by id.
/prm/api/objects/v1/CustomerAttachment/{id}
Permanently delete a specific customer attachment by its identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Customer Attachments by id.
/prm/api/objects/v1/CustomerAttachment
Permanently delete multiple customer attachments by their identifiers using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Customer Attachments corresponding to the given data fields.
/prm/api/objects/v1/CustomerAttachment
Retrieve a list of customer attachments matching the data fields provided in the request body using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Customer Attachments corresponding to the given parameters.
/prm/api/objects/v1/CustomerAttachment
Retrieve a list of customer attachments matching the query parameters using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Customer Attachment by id.
/prm/api/objects/v1/CustomerAttachment/{id}
Retrieve details for a single customer attachment by its identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Customer Attachment based on the specified view model.
/prm/api/objects/v1/CustomerAttachment/{id}
Update specific fields of an existing customer attachment by its identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Customer Attachments based on the specified view models.
/prm/api/objects/v1/CustomerAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
DealApprovalStatus Admin API (3)
POST Gets a list of Deal Approval Status corresponding to the given data fields.
/api/objects/v1/DealApprovalStatus
Retrieve a list of deal approval statuses matching the criteria provided in the request body using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Approval Status corresponding to the given parameters.
/api/objects/v1/DealApprovalStatus
Retrieve a list of deal approval statuses based on query parameters using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Approval Status by id.
/api/objects/v1/DealApprovalStatus/{id}
Retrieve the details of a single deal approval status by its identifier using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
DealApprovalStatus Member API (3)
POST Gets a list of Deal Approval Status corresponding to the given data fields.
/prm/api/objects/v1/DealApprovalStatus
Retrieve a list of deal approval statuses matching the criteria provided in the request body using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Approval Status corresponding to the given parameters.
/prm/api/objects/v1/DealApprovalStatus
Retrieve a list of deal approval statuses based on query parameters using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Approval Status by id.
/prm/api/objects/v1/DealApprovalStatus/{id}
Retrieve the details of a single deal approval status by its identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
DealAttachment Admin API (8)
PUT Adds a single or many Deal Attachments based on the specified view model(s).
/api/objects/v1/DealAttachment
Create or replace one or more deal attachments using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Deal Attachment by id.
/api/objects/v1/DealAttachment/{id}
Permanently delete a specific deal attachment by its identifier using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Deal Attachments by id.
/api/objects/v1/DealAttachment
Permanently delete multiple deal attachments by their identifiers using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Deal Attachments corresponding to the given data fields.
/api/objects/v1/DealAttachment
Retrieve a list of deal attachments matching the criteria provided in the request body using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Attachments corresponding to the given parameters.
/api/objects/v1/DealAttachment
Retrieve a list of deal attachments based on query parameters using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Attachment by id.
/api/objects/v1/DealAttachment/{id}
Retrieve the details of a single deal attachment by its identifier using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Deal Attachment based on the specified view model.
/api/objects/v1/DealAttachment/{id}
Update specific fields of an existing deal attachment by its identifier using admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Deal Attachments based on the specified view models.
/api/objects/v1/DealAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
DealAttachment Member API (8)
PUT Adds a single or many Deal Attachments based on the specified view model(s).
/prm/api/objects/v1/DealAttachment
Create one or more deal attachments using the member API. Use this to attach files or documents to a deal on behalf of a partner member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Deal Attachment by id.
/prm/api/objects/v1/DealAttachment/{id}
Delete a single deal attachment by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Deal Attachments by id.
/prm/api/objects/v1/DealAttachment
Delete multiple deal attachments in bulk by their identifiers using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Deal Attachments corresponding to the given data fields.
/prm/api/objects/v1/DealAttachment
Retrieve a filtered list of deal attachments by sending search and filter criteria in the request body via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Attachments corresponding to the given parameters.
/prm/api/objects/v1/DealAttachment
Retrieve a list of deal attachments matching the specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Attachment by id.
/prm/api/objects/v1/DealAttachment/{id}
Retrieve the details of a specific deal attachment by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Deal Attachment based on the specified view model.
/prm/api/objects/v1/DealAttachment/{id}
Update specific fields of an existing deal attachment by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Deal Attachments based on the specified view models.
/prm/api/objects/v1/DealAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
DealContact Admin API (8)
PUT Adds a single or many Deal Contacts based on the specified view model(s).
/api/objects/v1/DealContact
Create one or more deal contacts using the admin API. Use this to link contact records to deals with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Deal Contact by id.
/api/objects/v1/DealContact/{id}
Delete a single deal contact by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Deal Contacts by id.
/api/objects/v1/DealContact
Delete multiple deal contacts in bulk by their identifiers using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Deal Contacts corresponding to the given data fields.
/api/objects/v1/DealContact
Retrieve a filtered list of deal contacts by providing search criteria and field filters in the request body via the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Contacts corresponding to the given parameters.
/api/objects/v1/DealContact
Retrieve a list of deal contacts matching the specified query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Contact by id.
/api/objects/v1/DealContact/{id}
Retrieve the details of a specific deal contact by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Deal Contact based on the specified view model.
/api/objects/v1/DealContact/{id}
Update specific fields of an existing deal contact by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Deal Contacts based on the specified view models.
/api/objects/v1/DealContact
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
DealContact Member API (8)
PUT Adds a single or many Deal Contacts based on the specified view model(s).
/prm/api/objects/v1/DealContact
Create one or more deal contacts using the member API. Use this to associate contacts with a deal on behalf of a partner member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Deal Contact by id.
/prm/api/objects/v1/DealContact/{id}
Delete a single deal contact by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Deal Contacts by id.
/prm/api/objects/v1/DealContact
Delete multiple deal contacts in bulk by their identifiers using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Deal Contacts corresponding to the given data fields.
/prm/api/objects/v1/DealContact
Retrieve a filtered list of deal contacts by providing field criteria in the request body via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Contacts corresponding to the given parameters.
/prm/api/objects/v1/DealContact
Retrieve a list of deal contacts matching the specified query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Contact by id.
/prm/api/objects/v1/DealContact/{id}
Retrieve the details of a specific deal contact by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Deal Contact based on the specified view model.
/prm/api/objects/v1/DealContact/{id}
Update specific fields of an existing deal contact by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Deal Contacts based on the specified view models.
/prm/api/objects/v1/DealContact
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
DealStage Admin API (5)
DELETE /api/objects/v1/DealStage/delete/{stageId}
/api/objects/v1/DealStage/delete/{stageId}
Delete a deal stage and optionally reassign its associated records to another stage using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the deal stage to delete. |
|
|
The unique identifier of the deal stage to which existing deals should be reassigned. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/dealstage/_history
/api/objects/v1/dealstage/_history
Retrieve change history for deal stages using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the deal stage to filter history records by. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Deal Stages corresponding to the given data fields.
/api/objects/v1/DealStage
Retrieve a list of deal stages matching the specified criteria in the request body using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Stages corresponding to the given parameters.
/api/objects/v1/dealstage
Retrieve a list of deal stages based on the provided query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Stage by id.
/api/objects/v1/DealStage/{id}
Retrieve details for a single deal stage by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
DealStage Member API (4)
GET /prm/api/objects/v1/dealstage/_history
/prm/api/objects/v1/dealstage/_history
Retrieve change history for deal stages from the member portal perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the deal stage to filter history records by. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Deal Stages corresponding to the given data fields.
/prm/api/objects/v1/DealStage
Retrieve a list of deal stages matching the specified criteria in the request body from the member portal perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Stages corresponding to the given parameters.
/prm/api/objects/v1/dealstage
Retrieve a list of deal stages matching the provided query parameters from the member portal perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Stage by id.
/prm/api/objects/v1/DealStage/{id}
Retrieve details for a single deal stage by its unique identifier from the member portal perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
DealStep Admin API (3)
POST Gets a list of Deal Steps corresponding to the given data fields.
/api/objects/v1/DealStep
Retrieve a list of deal steps matching the specified criteria in the request body using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Steps corresponding to the given parameters.
/api/objects/v1/DealStep
Retrieve a list of deal steps matching the provided query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Step by id.
/api/objects/v1/DealStep/{id}
Retrieve details for a single deal step by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
DealStep Member API (3)
POST Gets a list of Deal Steps corresponding to the given data fields.
/prm/api/objects/v1/DealStep
Retrieve a list of deal steps matching the specified criteria in the request body from the member portal perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deal Steps corresponding to the given parameters.
/prm/api/objects/v1/DealStep
Retrieve a list of deal steps matching the provided query parameters from the member portal perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal Step by id.
/prm/api/objects/v1/DealStep/{id}
Retrieve details for a single deal step by its unique identifier from the member portal perspective.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Deals Admin API (9)
PUT Adds a single or many Deals based on the specified view model(s).
/api/objects/v1/Deal
Create or update one or more deals based on the provided model definitions using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Deal by id.
/api/objects/v1/Deal/{id}
Permanently delete a single deal by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Deals by id.
/api/objects/v1/Deal
Permanently delete multiple deals by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Deals corresponding to the given data fields.
/api/objects/v1/Deal
Retrieve a list of deals matching the criteria provided in the request body from the administrative endpoint. Use this when complex filtering conditions require a payload instead of query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deals corresponding to the given parameters.
/api/objects/v1/Deal
Retrieve a list of deals matching the specified query parameters from the administrative endpoint. Use this for standard queries and filtering of administrative deal records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal by id.
/api/objects/v1/Deal/{id}
Retrieve details for a single deal specified by ID using administrative permissions. Use this to inspect the properties of an individual deal record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Summaries this instance.
/api/objects/v1/deals/_summary
Retrieve summary metrics and aggregate information for administrative deals. Use this to obtain high-level overview data across deal records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Deal based on the specified view model.
/api/objects/v1/Deal/{id}
Update fields on an existing deal specified by ID using administrative privileges. Use this to apply partial modifications to a deal record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Deals based on the specified view models.
/api/objects/v1/Deal
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Deals Member API (9)
PUT Adds a single or many Deals based on the specified view model(s).
/prm/api/objects/v1/Deal
Create or upsert one or more deal records on behalf of a member. Use this to submit new deals or bulk updates through the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Deal by id.
/prm/api/objects/v1/Deal/{id}
Delete a specific deal by ID on behalf of a member. Use this to remove an individual deal record through the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Deals by id.
/prm/api/objects/v1/Deal
Delete multiple deals simultaneously by their identifiers on behalf of a member. Use this for bulk removal of deal records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Deals corresponding to the given data fields.
/prm/api/objects/v1/Deal
Retrieve a list of deals accessible to the member based on filter criteria provided in the request body. Use this when complex queries exceed standard URL parameter limits.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Deals corresponding to the given parameters.
/prm/api/objects/v1/Deal
Retrieve a list of deals accessible to the member matching the specified query parameters. Use this for standard member-level deal queries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Deal by id.
/prm/api/objects/v1/Deal/{id}
Retrieve the details of a specific deal by ID within the member context. Use this to view individual deal information available to the current member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Summaries this instance.
/prm/api/objects/v1/deals/_summary
Retrieve summary statistics and aggregate deal data within the member context. Use this to obtain an overview of deals associated with the member account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Deal based on the specified view model.
/prm/api/objects/v1/Deal/{id}
Update attributes on an existing deal by ID within the member context. Use this to apply partial changes to a member's deal record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Deals based on the specified view models.
/prm/api/objects/v1/Deal
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
End_Customer__co Admin API (11)
PUT Adds a single or many End Customers based on the specified view model(s).
/api/objects/v1/End_Customer__co
Create or upsert one or more custom End Customer records using administrative privileges. Use this to add new end customers or apply bulk updates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single End Customer by id.
/api/objects/v1/End_Customer__co/{id}
Delete a single custom End Customer record by its ID using administrative privileges. Use this to permanently remove an end customer entry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many End Customers by id.
/api/objects/v1/End_Customer__co
Delete multiple custom End Customer records at once using administrative privileges. Use this for batch removal of end customer entries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the End Customers based on the given data fields.
/api/objects/v1/End_Customer__co/_export
Export custom End Customer records matching the filter criteria provided in the request body. Use this when exporting large or complex subsets of end customer data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the End Customers based on the same get parameters.
/api/objects/v1/End_Customer__co/_export
Export custom End Customer records using query parameters. Use this to download end customer data based on standard filter criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of End Customers corresponding to the given data fields.
/api/objects/v1/End_Customer__co
Retrieve a list of End Customer records matching the criteria specified in the request body. Use this in administrative workflows to query customers using complex filter fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of End Customers corresponding to the given parameters.
/api/objects/v1/End_Customer__co
Retrieve a list of End Customer records using URL query parameters. Use this administrative action to filter and fetch multiple customer profiles.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single End Customer by id.
/api/objects/v1/End_Customer__co/{id}
Retrieve detailed information for a specific End Customer by its identifier in administrative mode.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for End Customer.
/api/objects/v1/End_Customer__co/_export/types
Retrieve the available export file types and formats supported for End Customer records under administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single End Customer based on the specified view model.
/api/objects/v1/End_Customer__co/{id}
Update specific fields of an existing End Customer record by its identifier using an administrative view model.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many End Customers based on the specified view models.
/api/objects/v1/End_Customer__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
End_Customer__co Member API (11)
PUT Adds a single or many End Customers based on the specified view model(s).
/prm/api/objects/v1/End_Customer__co
Create or replace one or more End Customer records as a member user. Use this action to bulk-upsert or add individual customer records to the portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single End Customer by id.
/prm/api/objects/v1/End_Customer__co/{id}
Delete a single End Customer record by its unique identifier from the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many End Customers by id.
/prm/api/objects/v1/End_Customer__co
Delete multiple End Customer records simultaneously from the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the End Customers based on the given data fields.
/prm/api/objects/v1/End_Customer__co/_export
Export End Customer records matching the criteria provided in the request body as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the End Customers based on the same get parameters.
/prm/api/objects/v1/End_Customer__co/_export
Export End Customer records matching the provided query parameters as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of End Customers corresponding to the given data fields.
/prm/api/objects/v1/End_Customer__co
Retrieve a list of End Customer records matching the filter payload provided in the request body from the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of End Customers corresponding to the given parameters.
/prm/api/objects/v1/End_Customer__co
Retrieve a list of End Customer records using query parameters from the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single End Customer by id.
/prm/api/objects/v1/End_Customer__co/{id}
Retrieve details of a single End Customer record by its unique identifier from the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for End Customer.
/prm/api/objects/v1/End_Customer__co/_export/types
Retrieve the available export file types and formats for End Customer records from the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single End Customer based on the specified view model.
/prm/api/objects/v1/End_Customer__co/{id}
Update selected fields on an existing End Customer record by its identifier as a member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many End Customers based on the specified view models.
/prm/api/objects/v1/End_Customer__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Entity Admin API (7)
GET /api/objects/v1/_describe/extendedProperties
/api/objects/v1/_describe/extendedProperties
Retrieve metadata describing the extended properties available across administrative entities.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/_describefor
/api/objects/v1/_describefor
Retrieve schema and metadata descriptions for objects tailored to a specific profile and context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter the object description schema by the category or type of profile. |
|
|
Filter the object description schema by the specific name of the profile. |
|
|
Specify the operational or environmental context to scope the returned metadata. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/{objectName}/_describefor
/api/objects/v1/{objectName}/_describefor
Retrieve contextual schema and relationship metadata for a specified object in the administrative context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object Name |
|
|
Filter the object description schema by the category or type of profile. |
|
|
Filter the object description schema by the specific name of the profile. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
Specifies the depth level of related object metadata to traverse and include in the response. |
|
|
Specify the operational or environmental context to scope the returned metadata. |
|
|
Indicates whether to filter related lists according to contextual permissions and configuration. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/{objectName}/_layout
/api/objects/v1/{objectName}/_layout
Retrieve the default user interface layout definition for a specified object in the administrative context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object Name |
|
|
Specifies the object relationship graph to apply when constructing the layout structure. |
|
|
Specifies the specific view name or layout variation to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/{objectName}/_layoutfor
/api/objects/v1/{objectName}/_layoutfor
Retrieve contextual user interface layout settings for a specified object under administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object Name |
|
|
Filter the object description schema by the category or type of profile. |
|
|
Filter the object description schema by the specific name of the profile. |
|
|
Specifies the relationship graph definition to include in the contextual layout. |
|
|
Specifies the target view name or context for which to return the layout. |
|
|
The response format expected from the API (e.g. application/json). |
GET Lists the available fields/child-relationships and their metadata for the specified object.
/api/objects/v1/{objectName}/_describe
Retrieve field definitions, child relationships, and associated schema metadata for a specified object in the administrative context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object Name |
|
|
An optional comma-delimited list of field names/uniqueids |
|
|
The depth to which foreign key definitions should be pursued. |
|
|
Specify the operational or environmental context to scope the returned metadata. |
|
|
When true, marks RelatedList fields as filterable in the response. |
|
|
The response format expected from the API (e.g. application/json). |
GET Lists the available objects and their metadata for your organization’s data.
/api/objects/v1/_describe
Retrieve a list of all data objects and their global metadata configured for the organization.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the operational or environmental context to scope the returned metadata. |
|
|
The response format expected from the API (e.g. application/json). |
Entity Member API (7)
GET /prm/api/objects/v1/_describe/extendedProperties
/prm/api/objects/v1/_describe/extendedProperties
Retrieve extended property metadata defined across objects accessible through the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/_describefor
/prm/api/objects/v1/_describefor
Retrieve contextual describe metadata for objects available to the current member user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Filter the object description schema by the category or type of profile. |
|
|
Filter the object description schema by the specific name of the profile. |
|
|
Specify the operational or environmental context to scope the returned metadata. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/{objectName}/_describefor
/prm/api/objects/v1/{objectName}/_describefor
Retrieve contextual schema details and relationships for a specific object within the member portal scope.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object Name |
|
|
Filter the object description schema by the category or type of profile. |
|
|
Filter the object description schema by the specific name of the profile. |
|
|
A comma-separated list of field names to retrieve for the member view. |
|
|
Specifies the recursion depth for retrieving child relationships and associated metadata. |
|
|
Specify the operational or environmental context to scope the returned metadata. |
|
|
Indicates whether to enable filtering on related lists in the returned metadata. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/{objectName}/_layout
/prm/api/objects/v1/{objectName}/_layout
Retrieve the interface layout definition for a specified object within the member portal scope.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object Name |
|
|
Specifies the relationship graph configuration to use when generating the layout. |
|
|
Specifies the member view mode or layout variant to retrieve. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/{objectName}/_layoutfor
/prm/api/objects/v1/{objectName}/_layoutfor
Retrieve a contextual layout structure for a specified object tailored to the current member user context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object Name |
|
|
Filter the object description schema by the category or type of profile. |
|
|
Filter the object description schema by the specific name of the profile. |
|
|
Specifies the relationship graph definition applied to the layout. |
|
|
Specifies the context-specific view identifier to fetch. |
|
|
The response format expected from the API (e.g. application/json). |
GET Lists the available fields/child-relationships and their metadata for the specified object.
/prm/api/objects/v1/{objectName}/_describe
Retrieve available fields, child relationships, and metadata for a specific object accessible within the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Object Name |
|
|
An optional comma-delimited list of field names/uniqueids |
|
|
The depth to which foreign key definitions should be pursued. |
|
|
Specify the operational or environmental context to scope the returned metadata. |
|
|
When true, marks RelatedList fields as filterable in the response. |
|
|
The response format expected from the API (e.g. application/json). |
GET Lists the available objects and their metadata for your organization’s data.
/prm/api/objects/v1/_describe
Retrieve all available objects and their top-level metadata accessible through the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specify the operational or environmental context to scope the returned metadata. |
|
|
The response format expected from the API (e.g. application/json). |
EventRegistration Admin API (8)
PUT Adds a single or many Event Registrations based on the specified view model(s).
/api/objects/v1/EventRegistration
Create or update one or more event registrations using the supplied record data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Event Registration by id.
/api/objects/v1/EventRegistration/{id}
Permanently remove a single event registration record by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Event Registrations by id.
/api/objects/v1/EventRegistration
Permanently remove multiple event registration records in bulk by their identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Event Registrations corresponding to the given data fields.
/api/objects/v1/EventRegistration
Retrieve a list of event registrations matching the specified data fields via the Admin API. Use this action to query event registrations using complex filter criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Event Registrations corresponding to the given parameters.
/api/objects/v1/EventRegistration
Retrieve a list of event registrations based on query parameters via the Admin API. Use this action to search and paginate through event registration records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Event Registration by id.
/api/objects/v1/EventRegistration/{id}
Retrieve a single event registration by its unique identifier via the Admin API. Use this action to inspect details of a specific registration record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Event Registration based on the specified view model.
/api/objects/v1/EventRegistration/{id}
Update specific fields of an existing event registration by its identifier via the Admin API. Use this action to apply partial updates to a registration record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Event Registrations based on the specified view models.
/api/objects/v1/EventRegistration
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
EventRegistration Member API (8)
PUT Adds a single or many Event Registrations based on the specified view model(s).
/prm/api/objects/v1/EventRegistration
Create or replace one or more event registrations via the Member API. Use this action when submitting new event registrations or bulk upserting registrations on behalf of members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Event Registration by id.
/prm/api/objects/v1/EventRegistration/{id}
Permanently delete a single event registration by its identifier via the Member API. Use this action to remove an individual registration record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Event Registrations by id.
/prm/api/objects/v1/EventRegistration
Delete multiple event registrations in bulk by their identifiers via the Member API. Use this action to clean up multiple registrations in a single operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Event Registrations corresponding to the given data fields.
/prm/api/objects/v1/EventRegistration
Retrieve a list of event registrations matching the provided data fields via the Member API. Use this action to perform targeted searches for registrations accessible to members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Event Registrations corresponding to the given parameters.
/prm/api/objects/v1/EventRegistration
Retrieve a list of event registrations matching URL query parameters via the Member API. Use this action to browse or paginate registrations accessible in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Event Registration by id.
/prm/api/objects/v1/EventRegistration/{id}
Retrieve a single event registration by its unique identifier via the Member API. Use this action to view the details of an individual member-accessible registration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Event Registration based on the specified view model.
/prm/api/objects/v1/EventRegistration/{id}
Update specific fields of an existing event registration by its identifier via the Member API. Use this action to modify member registration details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Event Registrations based on the specified view models.
/prm/api/objects/v1/EventRegistration
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
EventRegistrationApprovalStatus Admin API (3)
POST Gets a list of Event Registration Approval Status corresponding to the given data fields.
/api/objects/v1/EventRegistrationApprovalStatus
Retrieve a list of event registration approval statuses based on the provided data fields via the Admin API. Use this action to search for approval statuses using filter criteria in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Event Registration Approval Status corresponding to the given parameters.
/api/objects/v1/EventRegistrationApprovalStatus
Retrieve a list of event registration approval statuses matching the given query parameters via the Admin API. Use this action to inspect or paginate through available approval status records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Event Registration Approval Status by id.
/api/objects/v1/EventRegistrationApprovalStatus/{id}
Retrieve a single event registration approval status by its unique identifier via the Admin API. Use this action to view the details of a specific approval status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
EventRegistrationApprovalStatus Member API (3)
POST Gets a list of Event Registration Approval Status corresponding to the given data fields.
/prm/api/objects/v1/EventRegistrationApprovalStatus
Retrieve a list of event registration approval statuses matching specified data fields via the Member API. Use this action to query approval statuses accessible in the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Event Registration Approval Status corresponding to the given parameters.
/prm/api/objects/v1/EventRegistrationApprovalStatus
Retrieve a list of event registration approval statuses corresponding to query parameters via the Member API. Use this action to list available registration approval statuses for members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Event Registration Approval Status by id.
/prm/api/objects/v1/EventRegistrationApprovalStatus/{id}
Retrieve a single event registration approval status by its unique identifier via the Member API. Use this action to get details on a specific approval status available to members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
FieldSegment Admin API (4)
DELETE Deletes a single Field-based Segment by id.
/api/objects/v1/FieldSegment/{id}
Permanently delete a single field-based segment by its unique identifier via the Admin API. Use this action to remove an individual segmentation rule.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Field-based Segment by id.
/api/objects/v1/FieldSegment
Delete multiple field-based segments by their identifiers via the Admin API. Use this action to remove several segmentation rules in a single request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Field-based Segment based on the specified view model.
/api/objects/v1/FieldSegment/{id}
Update an existing field-based segment using its unique identifier and provided field values in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Field-based Segment based on the specified view models.
/api/objects/v1/FieldSegment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FieldSegment Member API (4)
DELETE Deletes a single Field-based Segment by id.
/prm/api/objects/v1/FieldSegment/{id}
Delete a specific field-based segment by its unique identifier in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Field-based Segment by id.
/prm/api/objects/v1/FieldSegment
Delete multiple field-based segments in the member context based on the provided identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Field-based Segment based on the specified view model.
/prm/api/objects/v1/FieldSegment/{id}
Update an existing field-based segment using its unique identifier and the provided view model in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Field-based Segment based on the specified view models.
/prm/api/objects/v1/FieldSegment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FileBlob Admin API (3)
POST Gets a list of File Blobs corresponding to the given data fields.
/api/objects/v1/FileBlob
Retrieve a list of file blobs matching criteria specified in the request body in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of File Blobs corresponding to the given parameters.
/api/objects/v1/FileBlob
Retrieve a list of file blobs matching query parameters in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single File Blob by id.
/api/objects/v1/FileBlob/{id}
Retrieve details of a specific file blob by its unique identifier in the admin context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
FileBlob Member API (3)
POST Gets a list of File Blobs corresponding to the given data fields.
/prm/api/objects/v1/FileBlob
Retrieve a list of file blobs matching criteria specified in the request body in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of File Blobs corresponding to the given parameters.
/prm/api/objects/v1/FileBlob
Retrieve a list of file blobs matching query parameters in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single File Blob by id.
/prm/api/objects/v1/FileBlob/{id}
Retrieve details of a specific file blob by its unique identifier in the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
FileBlobTemp Admin API (8)
POST Exports the File Blob Temps based on the given data fields.
/api/objects/v1/FileBlobTemp/_export
Export temporary file blobs matching criteria supplied in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the File Blob Temps based on the same get parameters.
/api/objects/v1/FileBlobTemp/_export
Export temporary file blobs matching criteria supplied in query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of File Blob Temps corresponding to the given data fields.
/api/objects/v1/FileBlobTemp
Retrieve a list of temporary file blobs matching criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of File Blob Temps corresponding to the given parameters.
/api/objects/v1/FileBlobTemp
Retrieve a list of temporary file blobs matching query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single File Blob Temp by id.
/api/objects/v1/FileBlobTemp/{id}
Retrieve details of a single temporary file blob by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for File Blob Temp.
/api/objects/v1/FileBlobTemp/_export/types
Retrieve the supported export format types available for temporary file blobs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single File Blob Temp based on the specified view model.
/api/objects/v1/FileBlobTemp/{id}
Update an existing temporary file blob by its unique identifier using the provided view model.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many File Blob Temps based on the specified view models.
/api/objects/v1/FileBlobTemp
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FileBlobTemp Member API (8)
POST Exports the File Blob Temps based on the given data fields.
/prm/api/objects/v1/FileBlobTemp/_export
Export temporary file blob records matching the filter criteria provided in the request payload. Use this to extract specific subsets of file blob records into an export file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the File Blob Temps based on the same get parameters.
/prm/api/objects/v1/FileBlobTemp/_export
Export temporary file blob records using criteria supplied through query parameters. Use this to generate an export file of file blobs based on standard query filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of File Blob Temps corresponding to the given data fields.
/prm/api/objects/v1/FileBlobTemp
Retrieve a list of temporary file blob records using the search and filter conditions specified in the request body. Useful when query parameters are insufficient for complex filter criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of File Blob Temps corresponding to the given parameters.
/prm/api/objects/v1/FileBlobTemp
Retrieve a list of temporary file blob records using URL query parameters. Use this for basic querying, sorting, and pagination of temporary file blobs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single File Blob Temp by id.
/prm/api/objects/v1/FileBlobTemp/{id}
Retrieve details for a specific temporary file blob record by its unique identifier. Use this to inspect the properties and status of an individual temporary file blob.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for File Blob Temp.
/prm/api/objects/v1/FileBlobTemp/_export/types
Retrieve all available export format types supported for temporary file blob records. Use this to determine valid export formats prior to requesting an export.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single File Blob Temp based on the specified view model.
/prm/api/objects/v1/FileBlobTemp/{id}
Update specific fields of an existing temporary file blob record by its unique identifier. Use this to apply partial modifications to a temporary file blob.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many File Blob Temps based on the specified view models.
/prm/api/objects/v1/FileBlobTemp
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FileSecuritySettings Admin API (12)
GET /api/objects/v1/FileSecuritySetting/meta/_all
/api/objects/v1/FileSecuritySetting/meta/_all
Retrieve all metadata definitions for file security settings in the admin context. Use this to inspect field structures, types, and configurations available for file security settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/FileSecuritySetting/meta/_defaults
/api/objects/v1/FileSecuritySetting/meta/_defaults
Retrieve default metadata values for file security settings in the admin context. Use this to inspect default configurations applied to new file security settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/FileSecuritySetting/meta/_supported
/api/objects/v1/FileSecuritySetting/meta/_supported
Retrieve supported metadata capabilities and properties for file security settings in the admin context. Use this to discover which attributes and operations are permitted.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /api/objects/v1/FileSecuritySetting/meta/{relatedType}
/api/objects/v1/FileSecuritySetting/meta/{relatedType}
Retrieve file security setting metadata associated with a specific related object type in the admin context. Use this to view configuration schema relevant to a given entity relationship.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specifies the related object type name whose file security setting metadata should be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many File Security Settings based on the specified view model(s).
/api/objects/v1/FileSecuritySetting
Create or update one or more file security settings in the admin context. Use this to upsert multiple file security configurations in a single request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single File Security Setting by id.
/api/objects/v1/FileSecuritySetting/{id}
Permanently remove a single file security setting by its unique identifier in the admin context. Use this to delete an unwanted security setting record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many File Security Settings by id.
/api/objects/v1/FileSecuritySetting
Delete multiple file security settings simultaneously in the admin context. Use this to remove a batch of security settings in one call.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of File Security Settings corresponding to the given data fields.
/api/objects/v1/FileSecuritySetting
Retrieve a list of file security settings matching the criteria supplied in the request body in the admin context. Useful for complex queries and filters on security configurations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of File Security Settings corresponding to the given parameters.
/api/objects/v1/FileSecuritySetting
Retrieve a list of file security settings using query parameters in the admin context. Use this to page through, search, and filter existing file security settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single File Security Setting by id.
/api/objects/v1/FileSecuritySetting/{id}
Retrieve the details of a specific file security setting by its unique identifier in the admin context. Use this to view the configuration of an individual setting.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single File Security Setting based on the specified view model.
/api/objects/v1/FileSecuritySetting/{id}
Update selected attributes of an existing file security setting by its unique identifier in the admin context. Use this to modify specific configuration values without overwriting the entire record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many File Security Settings based on the specified view models.
/api/objects/v1/FileSecuritySetting
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FileSecuritySettings Member API (12)
GET /prm/api/objects/v1/FileSecuritySetting/meta/_all
/prm/api/objects/v1/FileSecuritySetting/meta/_all
Retrieve all metadata definitions for file security settings in the member context. Use this to inspect the available schema, field properties, and rules accessible to member users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/FileSecuritySetting/meta/_defaults
/prm/api/objects/v1/FileSecuritySetting/meta/_defaults
Retrieve default metadata values for file security settings in the member API context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/FileSecuritySetting/meta/_supported
/prm/api/objects/v1/FileSecuritySetting/meta/_supported
Retrieve supported metadata capabilities and operations for file security settings in the member API context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
GET /prm/api/objects/v1/FileSecuritySetting/meta/{relatedType}
/prm/api/objects/v1/FileSecuritySetting/meta/{relatedType}
Retrieve metadata definitions for file security settings associated with a specified related type in the member API context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specifies the related object type name whose file security setting metadata should be retrieved. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Adds a single or many File Security Settings based on the specified view model(s).
/prm/api/objects/v1/FileSecuritySetting
Add one or more file security settings using the provided view model payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single File Security Setting by id.
/prm/api/objects/v1/FileSecuritySetting/{id}
Permanently remove a single file security setting identified by its unique ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many File Security Settings by id.
/prm/api/objects/v1/FileSecuritySetting
Permanently delete multiple file security settings matching the provided identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of File Security Settings corresponding to the given data fields.
/prm/api/objects/v1/FileSecuritySetting
Query and retrieve a list of file security settings based on criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of File Security Settings corresponding to the given parameters.
/prm/api/objects/v1/FileSecuritySetting
Retrieve a list of file security settings matching the supplied query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single File Security Setting by id.
/prm/api/objects/v1/FileSecuritySetting/{id}
Retrieve details of a single file security setting specified by its unique ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single File Security Setting based on the specified view model.
/prm/api/objects/v1/FileSecuritySetting/{id}
Update specific fields of an existing file security setting identified by its unique ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many File Security Settings based on the specified view models.
/prm/api/objects/v1/FileSecuritySetting
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FilterSegment Admin API (4)
DELETE Deletes a single Filter-based Segment by id.
/api/objects/v1/FilterSegment/{id}
Delete a single filter-based segment by its unique identifier using administrator privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Filter-based Segment by id.
/api/objects/v1/FilterSegment
Delete multiple filter-based segments by their identifiers using administrator privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Filter-based Segment based on the specified view model.
/api/objects/v1/FilterSegment/{id}
Update an existing filter-based segment by its unique ID using administrator privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Filter-based Segment based on the specified view models.
/api/objects/v1/FilterSegment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FilterSegment Member API (4)
DELETE Deletes a single Filter-based Segment by id.
/prm/api/objects/v1/FilterSegment/{id}
Delete a single filter-based segment by its unique identifier in the member API context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Filter-based Segment by id.
/prm/api/objects/v1/FilterSegment
Delete multiple filter-based segments by their identifiers in the member API context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Filter-based Segment based on the specified view model.
/prm/api/objects/v1/FilterSegment/{id}
Update an existing filter-based segment by its unique ID in the member API context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Filter-based Segment based on the specified view models.
/prm/api/objects/v1/FilterSegment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FilterSegmentGroup Admin API (4)
DELETE Deletes a single Filter Segment Group by id.
/api/objects/v1/FilterSegmentGroup/{id}
Delete a single filter segment group by its unique identifier using administrator privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Filter Segment Groups by id.
/api/objects/v1/FilterSegmentGroup
Delete multiple filter segment groups by their identifiers using administrator privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Filter Segment Group based on the specified view model.
/api/objects/v1/FilterSegmentGroup/{id}
Update an existing filter segment group by its unique ID using administrator privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Filter Segment Groups based on the specified view models.
/api/objects/v1/FilterSegmentGroup
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
FilterSegmentGroup Member API (4)
DELETE Deletes a single Filter Segment Group by id.
/prm/api/objects/v1/FilterSegmentGroup/{id}
Delete a single filter segment group by its unique identifier in the member API context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Filter Segment Groups by id.
/prm/api/objects/v1/FilterSegmentGroup
Delete multiple filter segment groups by their identifiers in the member API context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Filter Segment Group based on the specified view model.
/prm/api/objects/v1/FilterSegmentGroup/{id}
Update specific fields of an existing filter segment group via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Filter Segment Groups based on the specified view models.
/prm/api/objects/v1/FilterSegmentGroup
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Geography__co Admin API (11)
PUT Adds a single or many Geographies based on the specified view model(s).
/api/objects/v1/Geography__co
Create or replace one or more geography custom objects using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Geography by id.
/api/objects/v1/Geography__co/{id}
Permanently remove a single geography record by its identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Geographies by id.
/api/objects/v1/Geography__co
Delete multiple geography custom objects at once using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Geographies based on the given data fields.
/api/objects/v1/Geography__co/_export
Export geography records matching the filter criteria provided in the request body as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the Geographies based on the same get parameters.
/api/objects/v1/Geography__co/_export
Export geography records based on query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Geographies corresponding to the given data fields.
/api/objects/v1/Geography__co
Retrieve a list of geography custom objects matching the criteria supplied in the request body with admin permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Geographies corresponding to the given parameters.
/api/objects/v1/Geography__co
Retrieve a list of geography custom objects matching the specified query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Geography by id.
/api/objects/v1/Geography__co/{id}
Retrieve details for a single geography record by its identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for Geography.
/api/objects/v1/Geography__co/_export/types
Retrieve the supported export formats and file types available for geography custom objects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Geography based on the specified view model.
/api/objects/v1/Geography__co/{id}
Update specific fields of an existing geography record by its identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Geographies based on the specified view models.
/api/objects/v1/Geography__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Geography__co Member API (11)
PUT Adds a single or many Geographies based on the specified view model(s).
/prm/api/objects/v1/Geography__co
Create or replace one or more geography custom objects via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Geography by id.
/prm/api/objects/v1/Geography__co/{id}
Permanently remove a single geography record by its identifier via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Geographies by id.
/prm/api/objects/v1/Geography__co
Delete multiple geography custom objects at once via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Geographies based on the given data fields.
/prm/api/objects/v1/Geography__co/_export
Export geography records matching the criteria specified in the request body via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the Geographies based on the same get parameters.
/prm/api/objects/v1/Geography__co/_export
Export geography records matching the specified query parameters via the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Geographies corresponding to the given data fields.
/prm/api/objects/v1/Geography__co
Retrieve a list of geography records matching the filter criteria provided in the request body. Use this in member workflows to search geographies using complex payload queries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Geographies corresponding to the given parameters.
/prm/api/objects/v1/Geography__co
Retrieve a list of geography records matching the specified query parameters. Use this in member contexts to search and view available geographies.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Geography by id.
/prm/api/objects/v1/Geography__co/{id}
Retrieve the details of a single geography record by its unique identifier. Use this in member workflows to inspect an individual geography.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for Geography.
/prm/api/objects/v1/Geography__co/_export/types
Retrieve the available export file types and formats supported for geography data. Use this in member workflows to determine export configuration options.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Geography based on the specified view model.
/prm/api/objects/v1/Geography__co/{id}
Update specific fields of an existing geography record by its unique identifier. Use this in member workflows to modify geography properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Geographies based on the specified view models.
/prm/api/objects/v1/Geography__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
ImageCobrandArea Admin API (3)
POST Gets a list of Co-branding Template Image Area corresponding to the given data fields.
/api/objects/v1/ImageCobrandArea
Retrieve a list of co-branding template image areas matching the field criteria provided in the request body. Use this in administrative workflows to query template image areas.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Co-branding Template Image Area corresponding to the given parameters.
/api/objects/v1/ImageCobrandArea
Retrieve a list of co-branding template image areas matching the specified query parameters. Use this in administrative contexts to browse and search template image areas.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Co-branding Template Image Area by id.
/api/objects/v1/ImageCobrandArea/{id}
Retrieve the details of a specific co-branding template image area by its unique identifier. Use this in administrative workflows to view a single image area configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
ImageCobrandArea Member API (3)
POST Gets a list of Co-branding Template Image Area corresponding to the given data fields.
/prm/api/objects/v1/ImageCobrandArea
Retrieve a list of co-branding template image areas matching the field criteria submitted in the request body. Use this in member workflows to query template image areas.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Co-branding Template Image Area corresponding to the given parameters.
/prm/api/objects/v1/ImageCobrandArea
Retrieve a list of co-branding template image areas based on query parameters. Use this in member contexts to browse available template image areas.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Co-branding Template Image Area by id.
/prm/api/objects/v1/ImageCobrandArea/{id}
Retrieve the details of a specific co-branding template image area by its unique identifier. Use this in member workflows to view an individual image area.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
ImportTemplate Admin API (3)
POST Gets a list of Import Templates corresponding to the given data fields.
/api/objects/v1/ImportTemplate
Retrieve a list of import templates matching the criteria specified in the request body. Use this in administrative workflows to search available templates for data imports.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Import Templates corresponding to the given parameters.
/api/objects/v1/ImportTemplate
Retrieve a list of import templates matching the specified query parameters. Use this in administrative contexts to discover and review import templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Import Template by id.
/api/objects/v1/ImportTemplate/{id}
Retrieve the details of a specific import template by its unique identifier. Use this in administrative workflows to inspect the structure and settings of a template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
ImportTemplate Member API (3)
POST Gets a list of Import Templates corresponding to the given data fields.
/prm/api/objects/v1/ImportTemplate
Retrieve a list of import templates matching the filter criteria provided in the request body. Use this in member workflows to query available data import templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Import Templates corresponding to the given parameters.
/prm/api/objects/v1/ImportTemplate
Retrieve a list of import templates matching the provided query parameters. Use this in member contexts to view available templates for importing data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Import Template by id.
/prm/api/objects/v1/ImportTemplate/{id}
Retrieve the details of a specific import template by its unique identifier. Use this in member workflows to view template definitions and configurations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
InstalledLocale Admin API (3)
POST Gets a list of Locales corresponding to the given data fields.
/api/objects/v1/InstalledLocale
Retrieve a list of installed locales matching the specified filter criteria in the request body using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Locales corresponding to the given parameters.
/api/objects/v1/InstalledLocale
Retrieve a list of installed locales matching the provided query parameters using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Locale by id.
/api/objects/v1/InstalledLocale/{id}
Retrieve details for a specific installed locale by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
InstalledLocale Member API (3)
POST Gets a list of Locales corresponding to the given data fields.
/prm/api/objects/v1/InstalledLocale
Retrieve a list of installed locales matching the filter criteria provided in the request body using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Locales corresponding to the given parameters.
/prm/api/objects/v1/InstalledLocale
Retrieve a list of installed locales matching the provided query parameters using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Locale by id.
/prm/api/objects/v1/InstalledLocale/{id}
Retrieve details for a specific installed locale by its unique identifier using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
LMS_Test__co Admin API (11)
PUT Adds a single or many LMS Tests based on the specified view model(s).
/api/objects/v1/LMS_Test__co
Create or update one or more LMS test records using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single LMS Test by id.
/api/objects/v1/LMS_Test__co/{id}
Delete a specific LMS test record by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many LMS Tests by id.
/api/objects/v1/LMS_Test__co
Delete multiple LMS test records using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the LMS Tests based on the given data fields.
/api/objects/v1/LMS_Test__co/_export
Export LMS test records matching the criteria provided in the request body using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the LMS Tests based on the same get parameters.
/api/objects/v1/LMS_Test__co/_export
Export LMS test records matching the specified query parameters using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of LMS Tests corresponding to the given data fields.
/api/objects/v1/LMS_Test__co
Retrieve a list of LMS test records matching the filter criteria specified in the request body using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of LMS Tests corresponding to the given parameters.
/api/objects/v1/LMS_Test__co
Retrieve a list of LMS test records matching the specified query parameters using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single LMS Test by id.
/api/objects/v1/LMS_Test__co/{id}
Retrieve details for a specific LMS test record by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for LMS Test.
/api/objects/v1/LMS_Test__co/_export/types
Retrieve the list of supported export file formats available for LMS test records using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single LMS Test based on the specified view model.
/api/objects/v1/LMS_Test__co/{id}
Update fields on an existing LMS test record by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many LMS Tests based on the specified view models.
/api/objects/v1/LMS_Test__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
LMS_Test__co Member API (11)
PUT Adds a single or many LMS Tests based on the specified view model(s).
/prm/api/objects/v1/LMS_Test__co
Create or update one or more LMS test records using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single LMS Test by id.
/prm/api/objects/v1/LMS_Test__co/{id}
Delete a specific LMS test record by its unique identifier using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many LMS Tests by id.
/prm/api/objects/v1/LMS_Test__co
Delete multiple LMS test records using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the LMS Tests based on the given data fields.
/prm/api/objects/v1/LMS_Test__co/_export
Export LMS Test records matching criteria provided in the request body. Use this when defining complex filters or field selections to generate an export payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the LMS Tests based on the same get parameters.
/prm/api/objects/v1/LMS_Test__co/_export
Export LMS Test records matching query parameters supplied in the request. Use this to retrieve an exported data set using simple filter criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of LMS Tests corresponding to the given data fields.
/prm/api/objects/v1/LMS_Test__co
Retrieve a list of LMS Test records matching criteria defined in the request body. Use this for complex search or filtering requirements that cannot be represented in query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of LMS Tests corresponding to the given parameters.
/prm/api/objects/v1/LMS_Test__co
Retrieve a list of LMS Test records using query parameters. Use this to browse or filter tests based on standard query constraints.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single LMS Test by id.
/prm/api/objects/v1/LMS_Test__co/{id}
Retrieve the details of a single LMS Test record by its unique identifier. Use this to inspect a specific test's configuration and status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for LMS Test.
/prm/api/objects/v1/LMS_Test__co/_export/types
Retrieve the available export file types and formats supported for LMS Test records. Use this to inspect valid format options prior to generating an export.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single LMS Test based on the specified view model.
/prm/api/objects/v1/LMS_Test__co/{id}
Update specific fields of an existing LMS Test record by its unique identifier. Use this to apply partial modifications to a test without overwriting the entire record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many LMS Tests based on the specified view models.
/prm/api/objects/v1/LMS_Test__co
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Language Admin API (3)
POST Gets a list of Locales corresponding to the given data fields.
/api/objects/v1/Language
Retrieve a list of Locales matching the criteria specified in the request body using administrative privileges. Use this for advanced filtering of supported language and locale settings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Locales corresponding to the given parameters.
/api/objects/v1/Language
Retrieve a list of Locales using query parameters with administrative access. Use this to view or filter available system languages and locales.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Locale by id.
/api/objects/v1/Language/{id}
Retrieve details for a specific Locale by its unique identifier using administrative privileges. Use this to inspect the properties of an individual language configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Language Member API (3)
POST Gets a list of Locales corresponding to the given data fields.
/prm/api/objects/v1/Language
Retrieve a list of Locales matching criteria defined in the request body within the member context. Use this when member-level access is required to query available languages with advanced filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Locales corresponding to the given parameters.
/prm/api/objects/v1/Language
Retrieve a list of Locales using query parameters within the member context. Use this to fetch available language and locale options visible to members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Locale by id.
/prm/api/objects/v1/Language/{id}
Retrieve details for a specific Locale by its unique identifier within the member context. Use this to view language configuration details available to members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Lead Admin API (8)
PUT Adds a single or many Leads based on the specified view model(s).
/api/objects/v1/Lead
Create or update one or more Lead records using administrative privileges. Use this to ingest new leads or batch update existing lead information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Lead by id.
/api/objects/v1/Lead/{id}
Permanently delete a single Lead record by its unique identifier using administrative privileges. Use this to remove an individual lead from the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Leads by id.
/api/objects/v1/Lead
Permanently delete multiple Lead records by their identifiers in a single administrative operation. Use this to remove a batch of leads simultaneously.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Leads corresponding to the given data fields.
/api/objects/v1/Lead
Search and retrieve a list of leads using administrative permissions based on field criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Leads corresponding to the given parameters.
/api/objects/v1/Lead
Retrieve a list of leads matching the specified query parameters using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Lead by id.
/api/objects/v1/Lead/{id}
Retrieve details for a specific lead by its identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Lead based on the specified view model.
/api/objects/v1/Lead/{id}
Update an existing lead record by its identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Leads based on the specified view models.
/api/objects/v1/Lead
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Lead Member API (8)
PUT Adds a single or many Leads based on the specified view model(s).
/prm/api/objects/v1/Lead
Create one or multiple lead records as a partner portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Lead by id.
/prm/api/objects/v1/Lead/{id}
Delete a single lead record by its identifier as a partner portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Leads by id.
/prm/api/objects/v1/Lead
Delete multiple lead records by their identifiers as a partner portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Leads corresponding to the given data fields.
/prm/api/objects/v1/Lead
Search and retrieve leads accessible to the member based on field criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Leads corresponding to the given parameters.
/prm/api/objects/v1/Lead
Retrieve a list of leads accessible to the member filtered by query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Lead by id.
/prm/api/objects/v1/Lead/{id}
Retrieve details for a specific lead by its identifier as a partner portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Lead based on the specified view model.
/prm/api/objects/v1/Lead/{id}
Update an existing lead record by its identifier as a partner portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Leads based on the specified view models.
/prm/api/objects/v1/Lead
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
LeadApprovalStatus Admin API (3)
POST Gets a list of Lead Approval Status corresponding to the given data fields.
/api/objects/v1/LeadApprovalStatus
Search and retrieve lead approval status records with administrative permissions based on criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Lead Approval Status corresponding to the given parameters.
/api/objects/v1/LeadApprovalStatus
Retrieve a list of lead approval status records matching specified query parameters using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Lead Approval Status by id.
/api/objects/v1/LeadApprovalStatus/{id}
Retrieve details for a specific lead approval status record by its identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
LeadApprovalStatus Member API (3)
POST Gets a list of Lead Approval Status corresponding to the given data fields.
/prm/api/objects/v1/LeadApprovalStatus
Search and retrieve lead approval status records accessible to partner portal members based on criteria in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Lead Approval Status corresponding to the given parameters.
/prm/api/objects/v1/LeadApprovalStatus
Retrieve a list of lead approval status records accessible to partner portal members matching the specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Lead Approval Status by id.
/prm/api/objects/v1/LeadApprovalStatus/{id}
Retrieve details for a specific lead approval status by its identifier as a partner portal member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
LeadAttachment Admin API (8)
PUT Adds a single or many Lead Attachments based on the specified view model(s).
/api/objects/v1/LeadAttachment
Create one or more attachments associated with leads using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Lead Attachment by id.
/api/objects/v1/LeadAttachment/{id}
Delete an individual lead attachment by its identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Lead Attachments by id.
/api/objects/v1/LeadAttachment
Delete multiple lead attachments in bulk using their identifiers. Use this to remove several attachments at once with administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Lead Attachments corresponding to the given data fields.
/api/objects/v1/LeadAttachment
Retrieve a list of lead attachments matching specified field criteria. Use this for complex query filtering across attachments with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Lead Attachments corresponding to the given parameters.
/api/objects/v1/LeadAttachment
Retrieve a list of lead attachments matching the specified query criteria. Use this to search and inspect lead attachments as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Lead Attachment by id.
/api/objects/v1/LeadAttachment/{id}
Retrieve details for an individual lead attachment by its unique identifier. Use this to inspect file metadata or properties with administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Lead Attachment based on the specified view model.
/api/objects/v1/LeadAttachment/{id}
Update fields on an existing lead attachment using its unique identifier. Use this to modify attachment attributes with administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Lead Attachments based on the specified view models.
/api/objects/v1/LeadAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
LeadAttachment Member API (8)
PUT Adds a single or many Lead Attachments based on the specified view model(s).
/prm/api/objects/v1/LeadAttachment
Create one or more lead attachments. Use this within the member context to upload or associate new attachments with leads.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Lead Attachment by id.
/prm/api/objects/v1/LeadAttachment/{id}
Delete an individual lead attachment by its unique identifier. Use this to remove a specific attachment within the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Lead Attachments by id.
/prm/api/objects/v1/LeadAttachment
Delete multiple lead attachments in bulk using their identifiers. Use this to remove several attachments at once within the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Lead Attachments corresponding to the given data fields.
/prm/api/objects/v1/LeadAttachment
Retrieve a list of lead attachments matching specified field criteria. Use this to filter and search attachments using request payload data within the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Lead Attachments corresponding to the given parameters.
/prm/api/objects/v1/LeadAttachment
Retrieve a list of lead attachments according to the specified query criteria. Use this to browse or search attachments available to the member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Lead Attachment by id.
/prm/api/objects/v1/LeadAttachment/{id}
Retrieve details for a specific lead attachment by its unique identifier. Use this to view attachment properties accessible to the member.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Lead Attachment based on the specified view model.
/prm/api/objects/v1/LeadAttachment/{id}
Update an existing lead attachment using its unique identifier. Use this to modify lead attachment details within the member context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Lead Attachments based on the specified view models.
/prm/api/objects/v1/LeadAttachment
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
LeadStatus Admin API (4)
GET /api/objects/v1/leadstatus/_history
/api/objects/v1/leadstatus/_history
Retrieve the history of changes made to lead status records. Use this to audit lead status modifications and transitions with administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the deal stage to filter history records by. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Lead Status corresponding to the given data fields.
/api/objects/v1/LeadStatus
Retrieve a list of lead status records based on specified field filters. Use this to query and evaluate configured lead statuses as an administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Lead Status corresponding to the given parameters.
/api/objects/v1/LeadStatus
Retrieve a list of lead status records matching query criteria. Use this to review available lead statuses configured in the administrative system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Lead Status by id.
/api/objects/v1/LeadStatus/{id}
Retrieve details for a specific lead status by its unique identifier. Use this to inspect a single lead status definition with administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
LeadStatus Member API (4)
GET /prm/api/objects/v1/leadstatus/_history
/prm/api/objects/v1/leadstatus/_history
Retrieve historical change logs for lead statuses within the member context. Use this to review lead status changes and progression over time.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The unique identifier of the deal stage to filter history records by. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Lead Status corresponding to the given data fields.
/prm/api/objects/v1/LeadStatus
Retrieve a list of lead statuses matching the criteria provided in the request body. Use this member API action to search or filter lead statuses using complex data fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Lead Status corresponding to the given parameters.
/prm/api/objects/v1/LeadStatus
Retrieve a list of lead statuses matching specified query parameters. Use this member API action for standard lookups of lead status records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Lead Status by id.
/prm/api/objects/v1/LeadStatus/{id}
Retrieve details of a single lead status by its unique identifier. Use this member API action when you need information about a specific lead status record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Listing Admin API (4)
DELETE Deletes a single Listing by id.
/api/objects/v1/Listing/{id}
Permanently remove a single listing by its identifier. Use this administrative action when an individual listing is no longer needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Listings by id.
/api/objects/v1/Listing
Permanently remove multiple listings in a single request. Use this administrative action to perform batch deletions of listings.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Listing based on the specified view model.
/api/objects/v1/Listing/{id}
Apply partial updates to a single listing based on the provided view model. Use this administrative action to modify specific fields of an existing listing by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Listings based on the specified view models.
/api/objects/v1/Listing
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Listing Member API (4)
DELETE Deletes a single Listing by id.
/prm/api/objects/v1/Listing/{id}
Permanently remove a single listing by its identifier. Use this member API action to delete a specific listing record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Listings by id.
/prm/api/objects/v1/Listing
Permanently remove multiple listings in a single batch operation. Use this member API action to delete several listings at once.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Listing based on the specified view model.
/prm/api/objects/v1/Listing/{id}
Apply partial updates to a specific listing using the provided view model. Use this member API action to modify properties of an existing listing by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Listings based on the specified view models.
/prm/api/objects/v1/Listing
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
ListingCategory Admin API (4)
DELETE Deletes a single Listing Category by id.
/api/objects/v1/ListingCategory/{id}
Permanently remove a single listing category by its identifier. Use this administrative action to delete an unneeded category record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Listing Categories by id.
/api/objects/v1/ListingCategory
Permanently remove multiple listing categories in a single request. Use this administrative action to perform batch deletions of listing categories.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Listing Category based on the specified view model.
/api/objects/v1/ListingCategory/{id}
Apply partial updates to a single listing category based on the provided view model. Use this administrative action to modify fields of an existing listing category by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Listing Categories based on the specified view models.
/api/objects/v1/ListingCategory
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
ListingCategory Member API (4)
DELETE Deletes a single Listing Category by id.
/prm/api/objects/v1/ListingCategory/{id}
Permanently remove a single listing category by its identifier. Use this member API action to delete an individual category.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Listing Categories by id.
/prm/api/objects/v1/ListingCategory
Permanently remove multiple listing categories simultaneously. Use this member API action to bulk delete listing categories.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single Listing Category based on the specified view model.
/prm/api/objects/v1/ListingCategory/{id}
Apply partial updates to an existing listing category using the provided view model. Use this member API action to update specific category details by its identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Listing Categories based on the specified view models.
/prm/api/objects/v1/ListingCategory
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
LocalSuperAdmin Admin API (3)
POST Gets a list of Administrators corresponding to the given data fields.
/api/objects/v1/LocalSuperAdmin
Retrieve a list of local super administrators based on the filter criteria provided in the request body. Use this administrative action to query administrator accounts using complex data fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Administrators corresponding to the given parameters.
/api/objects/v1/LocalSuperAdmin
Retrieve a list of local super administrators matching the specified query parameters. Use this administrative action to search or paginate through administrator accounts.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Administrator by id.
/api/objects/v1/LocalSuperAdmin/{id}
Retrieve details of a single local super administrator by identifier. Use this administrative action to view the profile of a specific administrator.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
LocalSuperAdmin Member API (3)
POST Gets a list of Administrators corresponding to the given data fields.
/prm/api/objects/v1/LocalSuperAdmin
Retrieve a list of Local Super Administrators matching the specified criteria sent in the request body. Use this member-facing action to filter administrator records using complex field inputs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Administrators corresponding to the given parameters.
/prm/api/objects/v1/LocalSuperAdmin
Retrieve a list of Local Super Administrators matching the specified query parameters. Use this member-facing action to search or paginate through administrator records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Administrator by id.
/prm/api/objects/v1/LocalSuperAdmin/{id}
Retrieve details for a single Local Super Administrator by their identifier. Use this member-facing action to inspect a specific administrator record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
LocalSupportAdmin Admin API (3)
POST Gets a list of Administrators corresponding to the given data fields.
/api/objects/v1/LocalSupportAdmin
Retrieve a list of Local Support Administrators based on the provided field criteria. Use this administrative action when querying support administrators using body payload filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Administrators corresponding to the given parameters.
/api/objects/v1/LocalSupportAdmin
Retrieve a list of Local Support Administrators matching specified query parameters. Use this administrative action to look up or list support administrator records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Administrator by id.
/api/objects/v1/LocalSupportAdmin/{id}
Retrieve details for a specific Local Support Administrator by ID. Use this administrative action to fetch individual support administrator profiles.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
LocalSupportAdmin Member API (3)
POST Gets a list of Administrators corresponding to the given data fields.
/prm/api/objects/v1/LocalSupportAdmin
Retrieve a list of Local Support Administrators matching the provided data fields. Use this member-facing action to query administrator records using complex filter criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Administrators corresponding to the given parameters.
/prm/api/objects/v1/LocalSupportAdmin
Retrieve a list of Local Support Administrators based on query parameters. Use this member-facing action to list or filter support administrators.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Administrator by id.
/prm/api/objects/v1/LocalSupportAdmin/{id}
Retrieve details for a single Local Support Administrator by ID. Use this member-facing action to inspect a specific support administrator record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
Location Admin API (10)
PUT Add a defined Location
/api/objects/v1/location
Create a new location record. Use this administrative action to add a defined location to the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Location by id.
/api/objects/v1/Location/{id}
Delete a single location by its unique identifier. Use this administrative action to remove an individual location record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Locations by id.
/api/objects/v1/Location
Delete multiple locations at once. Use this administrative action to perform batch removal of location records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Locations corresponding to the given data fields.
/api/objects/v1/Location
Retrieve a list of locations matching the specified data fields. Use this administrative action to search locations using complex body criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Locations corresponding to the given parameters.
/api/objects/v1/Location
Retrieve a list of locations matching the specified query parameters. Use this administrative action to browse or filter existing locations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Location by id.
/api/objects/v1/Location/{id}
Retrieve details for a specific location by ID. Use this administrative action to fetch information about an individual location.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve location information from google's location autocomplete endpoint based on the location passed in
/api/objects/v1/location/_GetLocationsForSelection
Retrieve address suggestions from Google's location autocomplete service based on a search string. Use this administrative action to help users select valid locations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specifies the text search string to query Google autocomplete suggestions. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update a location
/api/objects/v1/location
Apply partial updates to a location record. Use this administrative action to modify one or more attributes of an existing location.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Location based on the specified view model.
/api/objects/v1/Location/{id}
Update a specific location by its identifier based on the provided view model. Use this administrative action to apply partial changes to a target location record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Locations based on the specified view models.
/api/objects/v1/Location
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
Location Member API (10)
PUT Add a defined Location
/prm/api/objects/v1/location
Create a new location record. Use this member-facing action to add a defined location.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Location by id.
/prm/api/objects/v1/Location/{id}
Delete a single location by its unique identifier. Use this member-facing action to remove an existing location record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Locations by id.
/prm/api/objects/v1/Location
Delete multiple Location records by their identifiers in the member portal. Use this action to remove batches of location entries at once.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Locations corresponding to the given data fields.
/prm/api/objects/v1/Location
Retrieve a list of Location records that match the specified request body fields in the member portal. Use this action to query locations using complex criteria or payload filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Locations corresponding to the given parameters.
/prm/api/objects/v1/Location
Retrieve a list of Location records matching the provided query parameters in the member portal. Use this action to browse or filter available partner locations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Location by id.
/prm/api/objects/v1/Location/{id}
Retrieve the details of a single Location record by its identifier in the member portal. Use this action to view complete information for a specific location.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve location information from google's location autocomplete endpoint based on the location passed in
/prm/api/objects/v1/location/_GetLocationsForSelection
Retrieve suggested location records from the Google location autocomplete service based on search criteria. Use this action to help users select standardized addresses or geographic places.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Specifies the text search string to query Google autocomplete suggestions. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update a location
/prm/api/objects/v1/location
Update location information in the member portal. Use this action to apply modifications across location properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Location based on the specified view model.
/prm/api/objects/v1/Location/{id}
Update a specific Location record identified by its unique identifier in the member portal. Use this action to apply changes to an existing location record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Locations based on the specified view models.
/prm/api/objects/v1/Location
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MDFClaimApprovalStatus Admin API (3)
POST Gets a list of Claim Approval Status corresponding to the given data fields.
/api/objects/v1/MDFClaimApprovalStatus
Retrieve a list of MDF claim approval status records matching specified filter fields via the administrative interface. Use this action to search claim approval states using structured criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Claim Approval Status corresponding to the given parameters.
/api/objects/v1/MDFClaimApprovalStatus
Retrieve a list of MDF claim approval status records matching specified query parameters via the administrative interface. Use this action to look up available approval statuses.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Claim Approval Status by id.
/api/objects/v1/MDFClaimApprovalStatus/{id}
Retrieve details for a single MDF claim approval status by its identifier via the administrative interface. Use this action to view the configuration of a specific approval status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
MDFClaimApprovalStatus Member API (3)
POST Gets a list of Claim Approval Status corresponding to the given data fields.
/prm/api/objects/v1/MDFClaimApprovalStatus
Retrieve a list of MDF claim approval status records corresponding to the provided data fields in the member portal. Use this action to query available approval statuses matching complex criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Claim Approval Status corresponding to the given parameters.
/prm/api/objects/v1/MDFClaimApprovalStatus
Retrieve a list of MDF claim approval status records matching query parameters in the member portal. Use this action to inspect available claim approval states available to members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Claim Approval Status by id.
/prm/api/objects/v1/MDFClaimApprovalStatus/{id}
Retrieve a single MDF claim approval status record by its unique identifier in the member portal. Use this action to inspect status details for a specific claim approval state.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
MDFClaimEngagement Admin API (8)
PUT Adds a single or many MDF Claim Engagements based on the specified view model(s).
/api/objects/v1/MDFClaimEngagement
Create or replace one or more MDF claim engagement records via the administrative interface. Use this action when importing or bulk-setting claim engagement entries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MDF Claim Engagement by id.
/api/objects/v1/MDFClaimEngagement/{id}
Delete a single MDF claim engagement record by its identifier via the administrative interface. Use this action to remove an individual engagement entry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MDF Claim Engagements by id.
/api/objects/v1/MDFClaimEngagement
Delete multiple MDF claim engagement records by their identifiers via the administrative interface. Use this action to remove engagements in bulk.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MDF Claim Engagements corresponding to the given data fields.
/api/objects/v1/MDFClaimEngagement
Retrieve a list of MDF claim engagement records that match the specified request body fields via the administrative interface. Use this action to filter engagements using complex criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MDF Claim Engagements corresponding to the given parameters.
/api/objects/v1/MDFClaimEngagement
Retrieve a list of MDF claim engagement records matching query parameters via the administrative interface. Use this action to search or paginate through claim engagements.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MDF Claim Engagement by id.
/api/objects/v1/MDFClaimEngagement/{id}
Retrieve details for a single MDF claim engagement record by its unique identifier via the administrative interface. Use this action to inspect a specific engagement.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MDF Claim Engagement based on the specified view model.
/api/objects/v1/MDFClaimEngagement/{id}
Update fields on a single MDF claim engagement record by its identifier via the administrative interface. Use this action to modify details on an existing engagement entry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MDF Claim Engagements based on the specified view models.
/api/objects/v1/MDFClaimEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MDFClaimEngagement Member API (8)
PUT Adds a single or many MDF Claim Engagements based on the specified view model(s).
/prm/api/objects/v1/MDFClaimEngagement
Create one or more MDF Claim Engagements in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MDF Claim Engagement by id.
/prm/api/objects/v1/MDFClaimEngagement/{id}
Delete a single MDF Claim Engagement by its unique identifier in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MDF Claim Engagements by id.
/prm/api/objects/v1/MDFClaimEngagement
Delete multiple MDF Claim Engagements by their identifiers in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MDF Claim Engagements corresponding to the given data fields.
/prm/api/objects/v1/MDFClaimEngagement
Retrieve a list of MDF Claim Engagements matching the specified field criteria in the request body in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MDF Claim Engagements corresponding to the given parameters.
/prm/api/objects/v1/MDFClaimEngagement
Retrieve a list of MDF Claim Engagements matching query parameters in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MDF Claim Engagement by id.
/prm/api/objects/v1/MDFClaimEngagement/{id}
Retrieve details for a single MDF Claim Engagement by its unique identifier in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MDF Claim Engagement based on the specified view model.
/prm/api/objects/v1/MDFClaimEngagement/{id}
Update specific fields of an existing MDF Claim Engagement by its unique identifier in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MDF Claim Engagements based on the specified view models.
/prm/api/objects/v1/MDFClaimEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MDFClaimNote Admin API (8)
PUT Adds a single or many Claim Notes based on the specified view model(s).
/api/objects/v1/MDFClaimNote
Create one or more MDF Claim Notes using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Claim Note by id.
/api/objects/v1/MDFClaimNote/{id}
Delete a single MDF Claim Note by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Claim Notes by id.
/api/objects/v1/MDFClaimNote
Delete multiple MDF Claim Notes by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Claim Notes corresponding to the given data fields.
/api/objects/v1/MDFClaimNote
Retrieve a list of MDF Claim Notes matching the specified field criteria in the request body using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Claim Notes corresponding to the given parameters.
/api/objects/v1/MDFClaimNote
Retrieve a list of MDF Claim Notes matching query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Claim Note by id.
/api/objects/v1/MDFClaimNote/{id}
Retrieve details for a single MDF Claim Note by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Claim Note based on the specified view model.
/api/objects/v1/MDFClaimNote/{id}
Update specific fields of an existing MDF Claim Note by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Claim Notes based on the specified view models.
/api/objects/v1/MDFClaimNote
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MDFClaimNote Member API (8)
PUT Adds a single or many Claim Notes based on the specified view model(s).
/prm/api/objects/v1/MDFClaimNote
Create one or more MDF Claim Notes in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Claim Note by id.
/prm/api/objects/v1/MDFClaimNote/{id}
Delete a single MDF Claim Note by its unique identifier in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Claim Notes by id.
/prm/api/objects/v1/MDFClaimNote
Delete multiple MDF Claim Notes by their identifiers in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Claim Notes corresponding to the given data fields.
/prm/api/objects/v1/MDFClaimNote
Retrieve a list of MDF Claim Notes matching the specified field criteria in the request body in the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Claim Notes corresponding to the given parameters.
/prm/api/objects/v1/MDFClaimNote
Retrieve a list of claim notes matching the specified query criteria in the member portal. Use this action to review communication records across claims.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Claim Note by id.
/prm/api/objects/v1/MDFClaimNote/{id}
Retrieve details for a specific claim note by its unique identifier in the member portal. Use this action when inspecting the contents of an individual note.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Claim Note based on the specified view model.
/prm/api/objects/v1/MDFClaimNote/{id}
Update specific fields of an existing claim note by its unique identifier in the member portal. Use this action to modify or append information to a claim note.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Claim Notes based on the specified view models.
/prm/api/objects/v1/MDFClaimNote
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MDFMarketingActivity Admin API (3)
POST Gets a list of Marketing Types corresponding to the given data fields.
/api/objects/v1/MDFMarketingActivity
Query and retrieve a list of marketing activities using specified criteria submitted in the request body. Use this action in administrative workflows requiring complex filtering.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Marketing Types corresponding to the given parameters.
/api/objects/v1/MDFMarketingActivity
Retrieve a list of marketing activities based on specified query parameters. Use this action in administrative workflows to browse or search available marketing activities.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Marketing Type by id.
/api/objects/v1/MDFMarketingActivity/{id}
Retrieve a specific marketing activity by its unique identifier. Use this administrative action to look up detailed information on a single marketing activity.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
MDFMarketingActivity Member API (3)
POST Gets a list of Marketing Types corresponding to the given data fields.
/prm/api/objects/v1/MDFMarketingActivity
Query and retrieve a list of marketing activities via criteria provided in the request body. Use this action in member portal workflows needing structured search capabilities.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Marketing Types corresponding to the given parameters.
/prm/api/objects/v1/MDFMarketingActivity
Retrieve a list of marketing activities matching query parameters in the member portal. Use this action to browse activities available to members.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Marketing Type by id.
/prm/api/objects/v1/MDFMarketingActivity/{id}
Retrieve the details of a specific marketing activity by its unique identifier in the member portal. Use this action to inspect a single activity's configuration.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
MDFRequestApprovalStatus Admin API (3)
POST Gets a list of Request Approval Status corresponding to the given data fields.
/api/objects/v1/MDFRequestApprovalStatus
Search and retrieve a list of MDF request approval statuses based on the provided data fields. Use this administrative action to filter approval status records via the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Request Approval Status corresponding to the given parameters.
/api/objects/v1/MDFRequestApprovalStatus
Retrieve a list of MDF request approval statuses matching the given query parameters. Use this administrative action to look up standard or custom status values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Request Approval Status by id.
/api/objects/v1/MDFRequestApprovalStatus/{id}
Retrieve an individual MDF request approval status by its unique identifier. Use this administrative action to view the specifics of a single approval status record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
MDFRequestApprovalStatus Member API (3)
POST Gets a list of Request Approval Status corresponding to the given data fields.
/prm/api/objects/v1/MDFRequestApprovalStatus
Search and retrieve a list of MDF request approval statuses matching criteria sent in the request body. Use this action within the member portal for advanced status queries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Request Approval Status corresponding to the given parameters.
/prm/api/objects/v1/MDFRequestApprovalStatus
Retrieve a list of MDF request approval statuses using query parameters. Use this member portal action to inspect available status values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Request Approval Status by id.
/prm/api/objects/v1/MDFRequestApprovalStatus/{id}
Retrieve a single MDF request approval status record by its unique identifier. Use this member portal action to fetch details for a particular approval status.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
MDFRequestEngagement Admin API (8)
PUT Adds a single or many MDF Request Engagements based on the specified view model(s).
/api/objects/v1/MDFRequestEngagement
Create or replace one or more MDF request engagement records based on the supplied payload. Use this administrative action to batch insert or update engagement data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MDF Request Engagement by id.
/api/objects/v1/MDFRequestEngagement/{id}
Permanently remove a single MDF request engagement record by its unique identifier. Use this administrative action to delete an individual engagement entry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MDF Request Engagements by id.
/api/objects/v1/MDFRequestEngagement
Permanently remove multiple MDF request engagement records. Use this administrative action to clean up multiple engagement entries simultaneously.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MDF Request Engagements corresponding to the given data fields.
/api/objects/v1/MDFRequestEngagement
Retrieve a list of MDF Request Engagements matching the specified data fields using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MDF Request Engagements corresponding to the given parameters.
/api/objects/v1/MDFRequestEngagement
Retrieve a list of MDF Request Engagements based on query parameters using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MDF Request Engagement by id.
/api/objects/v1/MDFRequestEngagement/{id}
Retrieve a single MDF Request Engagement by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MDF Request Engagement based on the specified view model.
/api/objects/v1/MDFRequestEngagement/{id}
Update an existing MDF Request Engagement by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MDF Request Engagements based on the specified view models.
/api/objects/v1/MDFRequestEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MDFRequestEngagement Member API (8)
PUT Adds a single or many MDF Request Engagements based on the specified view model(s).
/prm/api/objects/v1/MDFRequestEngagement
Create or update one or more MDF Request Engagements using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MDF Request Engagement by id.
/prm/api/objects/v1/MDFRequestEngagement/{id}
Delete a single MDF Request Engagement by its unique identifier using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MDF Request Engagements by id.
/prm/api/objects/v1/MDFRequestEngagement
Delete multiple MDF Request Engagements by their unique identifiers using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MDF Request Engagements corresponding to the given data fields.
/prm/api/objects/v1/MDFRequestEngagement
Retrieve a list of MDF Request Engagements matching the specified data fields using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MDF Request Engagements corresponding to the given parameters.
/prm/api/objects/v1/MDFRequestEngagement
Retrieve a list of MDF Request Engagements filtered by query parameters using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MDF Request Engagement by id.
/prm/api/objects/v1/MDFRequestEngagement/{id}
Retrieve a single MDF Request Engagement by its unique identifier using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MDF Request Engagement based on the specified view model.
/prm/api/objects/v1/MDFRequestEngagement/{id}
Update an existing MDF Request Engagement by its unique identifier using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MDF Request Engagements based on the specified view models.
/prm/api/objects/v1/MDFRequestEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MDFRequestNote Admin API (8)
PUT Adds a single or many Request Notes based on the specified view model(s).
/api/objects/v1/MDFRequestNote
Create or update one or more MDF Request Notes using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Request Note by id.
/api/objects/v1/MDFRequestNote/{id}
Delete a single MDF Request Note by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Request Notes by id.
/api/objects/v1/MDFRequestNote
Delete multiple MDF Request Notes by their unique identifiers using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Request Notes corresponding to the given data fields.
/api/objects/v1/MDFRequestNote
Retrieve a list of MDF Request Notes matching the specified data fields using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Request Notes corresponding to the given parameters.
/api/objects/v1/MDFRequestNote
Retrieve a list of MDF Request Notes based on query parameters using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Request Note by id.
/api/objects/v1/MDFRequestNote/{id}
Retrieve a single MDF Request Note by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Request Note based on the specified view model.
/api/objects/v1/MDFRequestNote/{id}
Update an existing MDF Request Note by its unique identifier using the Admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Request Notes based on the specified view models.
/api/objects/v1/MDFRequestNote
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MDFRequestNote Member API (8)
PUT Adds a single or many Request Notes based on the specified view model(s).
/prm/api/objects/v1/MDFRequestNote
Create or update one or more MDF Request Notes using the Member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Request Note by id.
/prm/api/objects/v1/MDFRequestNote/{id}
Permanently delete an individual request note by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Request Notes by id.
/prm/api/objects/v1/MDFRequestNote
Permanently delete multiple request notes simultaneously by their identifiers using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Request Notes corresponding to the given data fields.
/prm/api/objects/v1/MDFRequestNote
Search and retrieve a list of request notes that match the provided data fields using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Request Notes corresponding to the given parameters.
/prm/api/objects/v1/MDFRequestNote
Retrieve a list of request notes filtered by query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Request Note by id.
/prm/api/objects/v1/MDFRequestNote/{id}
Retrieve details for a single request note by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Request Note based on the specified view model.
/prm/api/objects/v1/MDFRequestNote/{id}
Update specific fields of an existing request note using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Request Notes based on the specified view models.
/prm/api/objects/v1/MDFRequestNote
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MFBDashboard Admin API (8)
PUT Adds a single or many Dashboards based on the specified view model(s).
/api/objects/v1/MFBDashboard
Create or replace one or more MFB dashboards from administrative settings based on the provided view models.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Dashboard by id.
/api/objects/v1/MFBDashboard/{id}
Permanently delete a specific MFB dashboard by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Dashboards by id.
/api/objects/v1/MFBDashboard
Permanently delete multiple MFB dashboards simultaneously by their identifiers using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Dashboards corresponding to the given data fields.
/api/objects/v1/MFBDashboard
Search and retrieve a list of MFB dashboards that correspond to specified data fields using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Dashboards corresponding to the given parameters.
/api/objects/v1/MFBDashboard
Retrieve a list of MFB dashboards matching the specified query parameters using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Dashboard by id.
/api/objects/v1/MFBDashboard/{id}
Retrieve details for a specific MFB dashboard by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Dashboard based on the specified view model.
/api/objects/v1/MFBDashboard/{id}
Update specific fields of an existing MFB dashboard by its unique identifier using the admin API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Dashboards based on the specified view models.
/api/objects/v1/MFBDashboard
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MFBDashboard Member API (8)
PUT Adds a single or many Dashboards based on the specified view model(s).
/prm/api/objects/v1/MFBDashboard
Create or replace one or more MFB dashboards based on the provided view models using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Dashboard by id.
/prm/api/objects/v1/MFBDashboard/{id}
Permanently delete an individual MFB dashboard by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Dashboards by id.
/prm/api/objects/v1/MFBDashboard
Permanently delete multiple MFB dashboards simultaneously by their identifiers using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Dashboards corresponding to the given data fields.
/prm/api/objects/v1/MFBDashboard
Search and retrieve a list of MFB dashboards that match the provided data fields using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Dashboards corresponding to the given parameters.
/prm/api/objects/v1/MFBDashboard
Retrieve a list of MFB dashboards filtered by query parameters using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Dashboard by id.
/prm/api/objects/v1/MFBDashboard/{id}
Retrieve details for an individual MFB dashboard by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Dashboard based on the specified view model.
/prm/api/objects/v1/MFBDashboard/{id}
Update specific fields of an existing MFB dashboard by its unique identifier using the member API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Dashboards based on the specified view models.
/prm/api/objects/v1/MFBDashboard
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MFBForm Admin API (8)
PUT Adds a single or many Forms based on the specified view model(s).
/api/objects/v1/MFBForm
Create one or multiple form records using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Form by id.
/api/objects/v1/MFBForm/{id}
Permanently remove a single form by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Forms by id.
/api/objects/v1/MFBForm
Permanently remove multiple forms in batch by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Forms corresponding to the given data fields.
/api/objects/v1/MFBForm
Query and retrieve a list of forms matching the provided data fields using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Forms corresponding to the given parameters.
/api/objects/v1/MFBForm
Retrieve a list of forms that match the specified query parameters using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Form by id.
/api/objects/v1/MFBForm/{id}
Retrieve the details of a single form by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Form based on the specified view model.
/api/objects/v1/MFBForm/{id}
Update specific fields of an existing form by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Forms based on the specified view models.
/api/objects/v1/MFBForm
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MFBForm Member API (8)
PUT Adds a single or many Forms based on the specified view model(s).
/prm/api/objects/v1/MFBForm
Create one or multiple form records using member privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Form by id.
/prm/api/objects/v1/MFBForm/{id}
Permanently remove a single form by its unique identifier using member privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Forms by id.
/prm/api/objects/v1/MFBForm
Permanently remove multiple forms in batch by their identifiers using member privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Forms corresponding to the given data fields.
/prm/api/objects/v1/MFBForm
Query and retrieve a list of forms matching the provided data fields using member privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Forms corresponding to the given parameters.
/prm/api/objects/v1/MFBForm
Retrieve a list of forms that match the specified query parameters using member privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Form by id.
/prm/api/objects/v1/MFBForm/{id}
Retrieve the details of a single form by its unique identifier using member privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Form based on the specified view model.
/prm/api/objects/v1/MFBForm/{id}
Update specific fields of an existing form by its unique identifier using member privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Forms based on the specified view models.
/prm/api/objects/v1/MFBForm
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MFBModule Admin API (8)
PUT Adds a single or many Modules based on the specified view model(s).
/api/objects/v1/MFBModule
Create one or multiple module records using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Module by id.
/api/objects/v1/MFBModule/{id}
Permanently remove a single module by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Modules by id.
/api/objects/v1/MFBModule
Permanently remove multiple modules in batch by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Modules corresponding to the given data fields.
/api/objects/v1/MFBModule
Query and retrieve a list of modules matching the provided data fields using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Modules corresponding to the given parameters.
/api/objects/v1/MFBModule
Retrieve a list of modules matching specified query criteria using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Module by id.
/api/objects/v1/MFBModule/{id}
Retrieve details for a single module by its unique identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Module based on the specified view model.
/api/objects/v1/MFBModule/{id}
Update fields of an existing module by its identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Modules based on the specified view models.
/api/objects/v1/MFBModule
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MFBModule Member API (8)
PUT Adds a single or many Modules based on the specified view model(s).
/prm/api/objects/v1/MFBModule
Create or replace one or more modules using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Module by id.
/prm/api/objects/v1/MFBModule/{id}
Delete a single module by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Modules by id.
/prm/api/objects/v1/MFBModule
Delete multiple modules in bulk using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of Modules corresponding to the given data fields.
/prm/api/objects/v1/MFBModule
Retrieve a list of modules matching the filter criteria provided in the request body using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Modules corresponding to the given parameters.
/prm/api/objects/v1/MFBModule
Retrieve a list of modules matching query parameters using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Module by id.
/prm/api/objects/v1/MFBModule/{id}
Retrieve details for a single module by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Module based on the specified view model.
/prm/api/objects/v1/MFBModule/{id}
Update fields of an existing module by its identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Modules based on the specified view models.
/prm/api/objects/v1/MFBModule
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPConfig Admin API (11)
PUT Adds a single or many Marketplace Configurations based on the specified view model(s).
/api/objects/v1/MPConfig
Create or replace one or more marketplace configurations using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Marketplace Configuration by id.
/api/objects/v1/MPConfig/{id}
Delete a single marketplace configuration by its unique identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Marketplace Configurations by id.
/api/objects/v1/MPConfig
Delete multiple marketplace configurations in bulk using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Marketplace Configurations based on the given data fields.
/api/objects/v1/MPConfig/_export
Export marketplace configuration records matching data fields defined in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the Marketplace Configurations based on the same get parameters.
/api/objects/v1/MPConfig/_export
Export marketplace configuration records matching the specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Marketplace Configurations corresponding to the given data fields.
/api/objects/v1/MPConfig
Retrieve a list of marketplace configurations matching data fields defined in the request body using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Marketplace Configurations corresponding to the given parameters.
/api/objects/v1/MPConfig
Retrieve a list of marketplace configurations matching specified query parameters using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Marketplace Configuration by id.
/api/objects/v1/MPConfig/{id}
Retrieve details for a single marketplace configuration by its unique identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for Marketplace Configuration.
/api/objects/v1/MPConfig/_export/types
Retrieve the available export file types supported for marketplace configuration data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Marketplace Configuration based on the specified view model.
/api/objects/v1/MPConfig/{id}
Update fields of an existing marketplace configuration by its identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Marketplace Configurations based on the specified view models.
/api/objects/v1/MPConfig
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPConfig Member API (11)
PUT Adds a single or many Marketplace Configurations based on the specified view model(s).
/prm/api/objects/v1/MPConfig
Create one or more Marketplace Configuration records based on the provided view models.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single Marketplace Configuration by id.
/prm/api/objects/v1/MPConfig/{id}
Permanently delete a specific Marketplace Configuration record by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many Marketplace Configurations by id.
/prm/api/objects/v1/MPConfig
Delete multiple Marketplace Configuration records simultaneously by their identifiers.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Exports the Marketplace Configurations based on the given data fields.
/prm/api/objects/v1/MPConfig/_export
Export Marketplace Configuration records based on the criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
The file format for the export output. |
|
|
The custom header configuration to apply to the exported file. |
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Exports the Marketplace Configurations based on the same get parameters.
/prm/api/objects/v1/MPConfig/_export
Export Marketplace Configuration records using specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search query |
|
|
target fields to return in the results |
|
|
Specific restrictions by field |
|
|
Comma separated list for sorting and whether or not to sort by desc or asc |
|
|
The expected file type of the export file |
|
|
The headers. |
|
|
The response format expected from the API (e.g. application/json). |
POST Gets a list of Marketplace Configurations corresponding to the given data fields.
/prm/api/objects/v1/MPConfig
Retrieve a list of Marketplace Configuration records matching the search criteria specified in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of Marketplace Configurations corresponding to the given parameters.
/prm/api/objects/v1/MPConfig
Retrieve a list of Marketplace Configuration records filtered by query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single Marketplace Configuration by id.
/prm/api/objects/v1/MPConfig/{id}
Retrieve the details of a single Marketplace Configuration record by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets the Export types available for Marketplace Configuration.
/prm/api/objects/v1/MPConfig/_export/types
Retrieve a list of available export formats supported for Marketplace Configurations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single Marketplace Configuration based on the specified view model.
/prm/api/objects/v1/MPConfig/{id}
Update specific fields of an existing Marketplace Configuration record by its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many Marketplace Configurations based on the specified view models.
/prm/api/objects/v1/MPConfig
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPContactBase Admin API (4)
DELETE Deletes a single MP Contact by id.
/api/objects/v1/MPContactBase/{id}
Permanently delete a single marketplace contact record by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Contacts by id.
/api/objects/v1/MPContactBase
Delete multiple marketplace contact records simultaneously by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Contact based on the specified view model.
/api/objects/v1/MPContactBase/{id}
Update specific fields of an existing marketplace contact record by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Contacts based on the specified view models.
/api/objects/v1/MPContactBase
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPContactBase Member API (4)
DELETE Deletes a single MP Contact by id.
/prm/api/objects/v1/MPContactBase/{id}
Permanently delete a single marketplace contact record by its unique identifier within the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Contacts by id.
/prm/api/objects/v1/MPContactBase
Delete multiple marketplace contact records simultaneously by their identifiers within the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Contact based on the specified view model.
/prm/api/objects/v1/MPContactBase/{id}
Update specific fields of an existing marketplace contact record by its unique identifier within the member portal.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Contacts based on the specified view models.
/prm/api/objects/v1/MPContactBase
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPContactNote Admin API (8)
PUT Adds a single or many MP Contact Notes based on the specified view model(s).
/api/objects/v1/MPContactNote
Create one or more marketplace contact note records using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Contact Note by id.
/api/objects/v1/MPContactNote/{id}
Permanently delete a single marketplace contact note record by its unique identifier using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Contact Notes by id.
/api/objects/v1/MPContactNote
Delete multiple marketplace contact note records simultaneously by their identifiers using administrative privileges.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Contact Notes corresponding to the given data fields.
/api/objects/v1/MPContactNote
Retrieve a list of MP Contact Notes matching specified filter fields using administrator permissions. Use this to query contact notes with complex criteria in the request payload.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Contact Notes corresponding to the given parameters.
/api/objects/v1/MPContactNote
Retrieve a list of MP Contact Notes filtered by query parameters using administrator permissions. Use this to search and paginate through contact notes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Contact Note by id.
/api/objects/v1/MPContactNote/{id}
Retrieve the details of a single MP Contact Note by its unique identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Contact Note based on the specified view model.
/api/objects/v1/MPContactNote/{id}
Update specific fields of an existing MP Contact Note by its unique identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Contact Notes based on the specified view models.
/api/objects/v1/MPContactNote
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPContactNote Member API (8)
PUT Adds a single or many MP Contact Notes based on the specified view model(s).
/prm/api/objects/v1/MPContactNote
Create one or more MP Contact Notes using member permissions. Use this when submitting contact notes from a portal or member account context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Contact Note by id.
/prm/api/objects/v1/MPContactNote/{id}
Delete a single MP Contact Note by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Contact Notes by id.
/prm/api/objects/v1/MPContactNote
Delete multiple MP Contact Notes in bulk using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Contact Notes corresponding to the given data fields.
/prm/api/objects/v1/MPContactNote
Retrieve a list of MP Contact Notes matching specified filter criteria in the request payload using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Contact Notes corresponding to the given parameters.
/prm/api/objects/v1/MPContactNote
Retrieve a list of MP Contact Notes based on query parameters using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Contact Note by id.
/prm/api/objects/v1/MPContactNote/{id}
Retrieve the details of a single MP Contact Note by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Contact Note based on the specified view model.
/prm/api/objects/v1/MPContactNote/{id}
Update specific fields of an existing MP Contact Note by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Contact Notes based on the specified view models.
/prm/api/objects/v1/MPContactNote
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPEngagement Admin API (4)
DELETE Deletes a single MP Engagement by id.
/api/objects/v1/MPEngagement/{id}
Delete a single MP Engagement by its unique identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Engagements by id.
/api/objects/v1/MPEngagement
Delete multiple MP Engagements in bulk using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Engagement based on the specified view model.
/api/objects/v1/MPEngagement/{id}
Update specific fields of an existing MP Engagement by its unique identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Engagements based on the specified view models.
/api/objects/v1/MPEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPEngagement Member API (4)
DELETE Deletes a single MP Engagement by id.
/prm/api/objects/v1/MPEngagement/{id}
Delete a single MP Engagement by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Engagements by id.
/prm/api/objects/v1/MPEngagement
Delete multiple MP Engagements in bulk using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Engagement based on the specified view model.
/prm/api/objects/v1/MPEngagement/{id}
Update specific fields of an existing MP Engagement by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Engagements based on the specified view models.
/prm/api/objects/v1/MPEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPFilterEngagement Admin API (8)
PUT Adds a single or many MP Filter Engagements based on the specified view model(s).
/api/objects/v1/MPFilterEngagement
Create one or more MP Filter Engagements using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Filter Engagement by id.
/api/objects/v1/MPFilterEngagement/{id}
Delete a single MP Filter Engagement by its unique identifier using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Filter Engagements by id.
/api/objects/v1/MPFilterEngagement
Delete multiple MP Filter Engagements in bulk using administrator permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Filter Engagements corresponding to the given data fields.
/api/objects/v1/MPFilterEngagement
Retrieve a list of MP Filter Engagements using administrative permissions based on specified filter criteria provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Filter Engagements corresponding to the given parameters.
/api/objects/v1/MPFilterEngagement
Retrieve a list of MP Filter Engagements using administrative permissions based on specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Filter Engagement by id.
/api/objects/v1/MPFilterEngagement/{id}
Retrieve the details of a single MP Filter Engagement by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Filter Engagement based on the specified view model.
/api/objects/v1/MPFilterEngagement/{id}
Update specific fields of an existing MP Filter Engagement by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Filter Engagements based on the specified view models.
/api/objects/v1/MPFilterEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPFilterEngagement Member API (8)
PUT Adds a single or many MP Filter Engagements based on the specified view model(s).
/prm/api/objects/v1/MPFilterEngagement
Create or replace one or more MP Filter Engagements within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Filter Engagement by id.
/prm/api/objects/v1/MPFilterEngagement/{id}
Permanently delete a single MP Filter Engagement by its unique identifier within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Filter Engagements by id.
/prm/api/objects/v1/MPFilterEngagement
Permanently delete multiple MP Filter Engagements by their unique identifiers within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Filter Engagements corresponding to the given data fields.
/prm/api/objects/v1/MPFilterEngagement
Retrieve a list of MP Filter Engagements matching criteria provided in the request body within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Filter Engagements corresponding to the given parameters.
/prm/api/objects/v1/MPFilterEngagement
Retrieve a list of MP Filter Engagements matching specified query parameters within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Filter Engagement by id.
/prm/api/objects/v1/MPFilterEngagement/{id}
Retrieve the details of a single MP Filter Engagement by its unique identifier within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Filter Engagement based on the specified view model.
/prm/api/objects/v1/MPFilterEngagement/{id}
Update specific fields of an existing MP Filter Engagement by its unique identifier within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Filter Engagements based on the specified view models.
/prm/api/objects/v1/MPFilterEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPListingBase Admin API (4)
DELETE Deletes a single MP Listing by id.
/api/objects/v1/MPListingBase/{id}
Permanently delete a single MP Listing by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Listings by id.
/api/objects/v1/MPListingBase
Permanently delete multiple MP Listings by their unique identifiers using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Listing based on the specified view model.
/api/objects/v1/MPListingBase/{id}
Update specific fields of an existing MP Listing by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Listings based on the specified view models.
/api/objects/v1/MPListingBase
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPListingBase Member API (4)
DELETE Deletes a single MP Listing by id.
/prm/api/objects/v1/MPListingBase/{id}
Permanently delete a single MP Listing by its unique identifier within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Listings by id.
/prm/api/objects/v1/MPListingBase
Permanently delete multiple MP Listings by their unique identifiers within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Listing based on the specified view model.
/prm/api/objects/v1/MPListingBase/{id}
Update specific fields of an existing MP Listing by its unique identifier within the member portal context.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Listings based on the specified view models.
/prm/api/objects/v1/MPListingBase
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPListingItemRequestBase Admin API (4)
DELETE Deletes a single MP Listing Item Request by id.
/api/objects/v1/MPListingItemRequestBase/{id}
Permanently delete a single MP Listing Item Request by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Listing Item Requests by id.
/api/objects/v1/MPListingItemRequestBase
Permanently delete multiple MP Listing Item Requests by their unique identifiers using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Listing Item Request based on the specified view model.
/api/objects/v1/MPListingItemRequestBase/{id}
Update specific fields of an existing MP Listing Item Request by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Listing Item Requests based on the specified view models.
/api/objects/v1/MPListingItemRequestBase
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPListingItemRequestBase Member API (4)
DELETE Deletes a single MP Listing Item Request by id.
/prm/api/objects/v1/MPListingItemRequestBase/{id}
Delete a single MP listing item request by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Listing Item Requests by id.
/prm/api/objects/v1/MPListingItemRequestBase
Delete multiple MP listing item requests by their identifiers using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Listing Item Request based on the specified view model.
/prm/api/objects/v1/MPListingItemRequestBase/{id}
Update an existing MP listing item request by its unique identifier based on the provided data model using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Listing Item Requests based on the specified view models.
/prm/api/objects/v1/MPListingItemRequestBase
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPListingRequestBase Admin API (4)
DELETE Deletes a single MP Listing Request by id.
/api/objects/v1/MPListingRequestBase/{id}
Delete a single MP listing request by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Listing Requests by id.
/api/objects/v1/MPListingRequestBase
Delete multiple MP listing requests by their identifiers using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Listing Request based on the specified view model.
/api/objects/v1/MPListingRequestBase/{id}
Update an existing MP listing request by its unique identifier based on the provided data model using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Listing Requests based on the specified view models.
/api/objects/v1/MPListingRequestBase
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPListingRequestBase Member API (4)
DELETE Deletes a single MP Listing Request by id.
/prm/api/objects/v1/MPListingRequestBase/{id}
Delete a single MP listing request by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Listing Requests by id.
/prm/api/objects/v1/MPListingRequestBase
Delete multiple MP listing requests by their identifiers using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
PATCH Updates a single MP Listing Request based on the specified view model.
/prm/api/objects/v1/MPListingRequestBase/{id}
Update an existing MP listing request by its unique identifier based on the provided data model using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Listing Requests based on the specified view models.
/prm/api/objects/v1/MPListingRequestBase
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPPartnerListingEngagement Admin API (8)
PUT Adds a single or many MP Partner Listing Engagements based on the specified view model(s).
/api/objects/v1/MPPartnerListingEngagement
Create one or more MP partner listing engagements based on the provided data models using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Partner Listing Engagement by id.
/api/objects/v1/MPPartnerListingEngagement/{id}
Delete a single MP partner listing engagement by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Partner Listing Engagements by id.
/api/objects/v1/MPPartnerListingEngagement
Delete multiple MP partner listing engagements by their identifiers using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Partner Listing Engagements corresponding to the given data fields.
/api/objects/v1/MPPartnerListingEngagement
Search and retrieve a list of MP partner listing engagements matching the data fields specified in the request body using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Partner Listing Engagements corresponding to the given parameters.
/api/objects/v1/MPPartnerListingEngagement
Retrieve a list of MP partner listing engagements matching the specified filter parameters using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Partner Listing Engagement by id.
/api/objects/v1/MPPartnerListingEngagement/{id}
Retrieve a single MP partner listing engagement by its unique identifier using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates a single MP Partner Listing Engagement based on the specified view model.
/api/objects/v1/MPPartnerListingEngagement/{id}
Update an existing MP partner listing engagement by its unique identifier based on the provided data model using administrative permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
Any extra fields to return, in addition to those that are already returned. |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Updates many MP Partner Listing Engagements based on the specified view models.
/api/objects/v1/MPPartnerListingEngagement
The success flag will be false if any items failed to update.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The return fields. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The identifier or field key corresponding to the account property to update. |
|
|
The new value to assign to the specified account key. |
MPPartnerListingEngagement Member API (6)
PUT Adds a single or many MP Partner Listing Engagements based on the specified view model(s).
/prm/api/objects/v1/MPPartnerListingEngagement
Create one or more MP partner listing engagements based on the provided data models using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The view model payload containing account details to add. |
DELETE Deletes a single MP Partner Listing Engagement by id.
/prm/api/objects/v1/MPPartnerListingEngagement/{id}
Delete a single MP partner listing engagement by its unique identifier using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Deletes many MP Partner Listing Engagements by id.
/prm/api/objects/v1/MPPartnerListingEngagement
Delete multiple MP partner listing engagements by their identifiers using member permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The list of account IDs to delete. |
POST Gets a list of MP Partner Listing Engagements corresponding to the given data fields.
/prm/api/objects/v1/MPPartnerListingEngagement
Retrieve a list of MP partner listing engagements matching the specified data fields in the request payload. Use this in member contexts to query engagements using advanced filtering criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The filter expression to apply when retrieving accounts. |
|
|
The identifier of the view defining default fields and filtering criteria. |
|
|
The array of field names to include in each returned account record. |
|
|
A text query to match across searchable account fields. |
|
|
The number of account records to skip for pagination. |
|
|
The maximum number of account records to return. |
GET Gets a list of MP Partner Listing Engagements corresponding to the given parameters.
/prm/api/objects/v1/MPPartnerListingEngagement
Retrieve a list of MP partner listing engagements matching the specified query parameters. Use this in member contexts to browse or filter engagement records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Search text |
|
|
Comma separated list of fields to retrieve |
|
|
Optional where clause (eg, Field1 = Val1 and Field2 > Val2) |
|
|
Comma separated list of fields to sort by |
|
|
Number of results to skip for pagination. |
|
|
Number of results to take for pagination. |
|
|
The response format expected from the API (e.g. application/json). |
GET Gets a single MP Partner Listing Engagement by id.
/prm/api/objects/v1/MPPartnerListingEngagement/{id}
Retrieve the details of a single MP partner listing engagement by its unique ID. Use this in member contexts to inspect a specific engagement record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Additional query string name/value pairs to append to the request URL. |
|
|
Target Id |
|
|
Comma separated list of fields to retrieve |
|
|
The response format expected from the API (e.g. application/json). |