Skip to main content

CRM

API docs by Redocly

CRM (1.0)

Download OpenAPI specification:Download

Anthology, Inc.: support@anthology.com URL: https://www.anthology.com

All API calls related to CRM.

Document

Add Document List For Student

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-adddocumentlistforstudent-request-payload)
studentId
number <int32>
enrollmentId
number <int32>
documentTypeListId
number <int32>
documentStatusId
number <int32>
awardYear
string
studentPlacementId
number <int32>
dateRequested
string <date-time>
dateSent
string <date-time>
dateApproved
string <date-time>
dateDue
string <date-time>
dateReceived
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Clear Student Document

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-clearstudentdocument-request-payload)
documentId
number <int32>
documentImage
string <byte>
fileNameWithExtension
string
moduleIdentifier
string
moduleCode
string
moduleName
string
documentTypeCode
string
documentTypeName
string
externalDocumentTypeIdentifier
string
awardYear
string
externalDocumentIdentifier
string
fileBytes
string
fileSize
string
fileTypeIdentifier
string
programVersionCode
string
vendorCode
string
campusCode
string
campusId
number <int32>
crmIdentifier
string
emailAddress
string
studentFirstName
string
studentLastName
string
programCode
string
programName
string
programVersionName
string
startDate
string
studentId
number <int32>
studentNumber
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Document

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Document

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-delete-request-payload)
id
number <int32>

Id

approvedDate
string <date-time>

The date that the institution accepted the documents submitted by the student, or by persons and organizations connected with the student.

awardYear
string

The financial aid award year which is the period beginning July 1 and ending June 30 of the following year.

createdByUserId
number <int32>

The last and then first name of the staff member who added or created the item.

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

documentImage
string <byte>

The documents submitted by a student, or by persons and organizations connected with the student.

documentScheduleId
number <int32>

Document Schedule Id

documentStatusId
number <int32>

The status of the document. The list contains the predefined statuses of Requested - Required, Requested - Not Required, Approved, No Further Action, Not Requested, Required, Received but Rejected, Sent, and Not Sent. Any additional items in the lists were defined by your organization.

documentTranscriptRequestId
number <int32>

Document Transcript Request Id

documentTriggerId
number <int32>

Document Trigger Id

documentTypeId
number <int32>

The type of document submitted to the institution.

dueDate
string <date-time>

The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date.

expiresDate
string <date-time>

The date when the group or document is no longer valid. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date. The default is calculated using the value for Default Number of Days to Retain Student Groups on the Options tab for the campus in the Desktop Client (Setup > Campus Location).

imageNowDocId0
string

Image Now Doc Id0

imageNowDocId1
string

Image Now Doc Id1

imageType
string

Image Type

isDocumentAddedManually
boolean

Is Document Added Manually

isPermit
boolean

Is Permit

lastModifiedDateTime
string <date-time>

The date that the item was updated or changed.

lastModifiedUserId
number <int32>

The last and then first name of the person that changed the item.

moduleId
number <int32>

The various categories that pertain to functional areas within an institution. For example, Academic Records, Financial Aid, and so on.

note
string

Area you can use to display or specify comments or additional information.

originalFileName
string

Original File Name

receivedDate
string <date-time>

The date the institution received the documents submitted by the student, or by persons and organizations connected with the student.

requestedDate
string <date-time>

The date when an institution, person, or a student requested documents or information to be submitted for evaluation.

rowVersion
string
scanned
boolean

Scanned

sentDate
string <date-time>

The date when the requested information or document is sent.

studentEnrollmentPeriodId
number <int32>

The code and name of the enrollment.

studentId
number <int32>

Student Id

studentPlacementId
number <int32>

Student Placement Id

workflowInstanceIdentifier
object

Workflow Instance Identifier

object (cmc-nexus-crm-entities-documentTranscriptRequestEntity)
Array of objects (cmc-nexus-crm-entities-studentCourseDocumentPermitEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Course Document Permits

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-deletestudentcoursedocumentpermits-request-payload)
documentId
number <int32>
studentId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Export Student Attachments

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-exportstudentattachments-request-payload)
minimumDate
string <date-time>
maximumDate
string <date-time>
documentStatusIdList
Array of numbers <int32> [ items <int32 > ]
isIncludeProposedRecords
boolean
documentIdList
Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Export Student Attachments Queue

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-exportstudentattachmentsqueue-request-payload)
minimumDate
string <date-time>
maximumDate
string <date-time>
documentStatusIdList
Array of numbers <int32> [ items <int32 > ]
isIncludeProposedRecords
boolean
documentIdList
Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Document

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Document

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-getdocument-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Document From External Document Management Provider

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-getdocumentfromexternaldocumentmanagementprovider-request-payload)
isAutoRedirect
boolean
campusId
number <int32>
studentId
number <int32>
documentId
number <int32>
studentName
string
studentNumber
string
documentTypeName
string
documentTypeCode
string
moduleCode
string
providerDocumentIdentifier
string
vendorCode
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Document Statuses

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-getdocumentstatuses-request-payload)
documentTypeIdList
Array of numbers <int32> [ items <int32 > ]
intersectionOfStatuses
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Document Tracking List

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-getdocumenttrackinglist-request-payload)
campusId
number <int32>
moduleId
number <int32>
documentTypeIdList
Array of numbers <int32> [ items <int32 > ]
documentStatusIdList
Array of numbers <int32> [ items <int32 > ]
awardYear
string
viewDocumentsNotReceived
boolean
studentNumber
string
ssn
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Students Document Assignment

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-getstudentsdocumentassignment-request-payload)
campusId
number <int32>
startDate
string <date-time>
endDate
string <date-time>
aYStartDate
string <date-time>
aYEndDate
string <date-time>
gradStartDate
string <date-time>
gradEndDate
string <date-time>
degreeId
number <int32>
studentGroupId
number <int32>
programVersions
Array of numbers <int32> [ items <int32 > ]
schoolStatuses
Array of numbers <int32> [ items <int32 > ]
lowRemainingUnits
number <int32>
highRemainingUnits
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Document

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-save-request-payload)
id
number <int32>

Id

approvedDate
string <date-time>

The date that the institution accepted the documents submitted by the student, or by persons and organizations connected with the student.

awardYear
string

The financial aid award year which is the period beginning July 1 and ending June 30 of the following year.

createdByUserId
number <int32>

The last and then first name of the staff member who added or created the item.

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

documentImage
string <byte>

The documents submitted by a student, or by persons and organizations connected with the student.

documentScheduleId
number <int32>

Document Schedule Id

documentStatusId
number <int32>

The status of the document. The list contains the predefined statuses of Requested - Required, Requested - Not Required, Approved, No Further Action, Not Requested, Required, Received but Rejected, Sent, and Not Sent. Any additional items in the lists were defined by your organization.

documentTranscriptRequestId
number <int32>

Document Transcript Request Id

documentTriggerId
number <int32>

Document Trigger Id

documentTypeId
number <int32>

The type of document submitted to the institution.

dueDate
string <date-time>

The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date.

expiresDate
string <date-time>

The date when the group or document is no longer valid. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date. The default is calculated using the value for Default Number of Days to Retain Student Groups on the Options tab for the campus in the Desktop Client (Setup > Campus Location).

imageNowDocId0
string

Image Now Doc Id0

imageNowDocId1
string

Image Now Doc Id1

imageType
string

Image Type

isDocumentAddedManually
boolean

Is Document Added Manually

isPermit
boolean

Is Permit

lastModifiedDateTime
string <date-time>

The date that the item was updated or changed.

lastModifiedUserId
number <int32>

The last and then first name of the person that changed the item.

moduleId
number <int32>

The various categories that pertain to functional areas within an institution. For example, Academic Records, Financial Aid, and so on.

note
string

Area you can use to display or specify comments or additional information.

originalFileName
string

Original File Name

receivedDate
string <date-time>

The date the institution received the documents submitted by the student, or by persons and organizations connected with the student.

requestedDate
string <date-time>

The date when an institution, person, or a student requested documents or information to be submitted for evaluation.

rowVersion
string
scanned
boolean

Scanned

sentDate
string <date-time>

The date when the requested information or document is sent.

studentEnrollmentPeriodId
number <int32>

The code and name of the enrollment.

studentId
number <int32>

Student Id

studentPlacementId
number <int32>

Student Placement Id

workflowInstanceIdentifier
object

Workflow Instance Identifier

object (cmc-nexus-crm-entities-documentTranscriptRequestEntity)
Array of objects (cmc-nexus-crm-entities-studentCourseDocumentPermitEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Document

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-savenew-request-payload)
id
number <int32>

Id

approvedDate
string <date-time>

The date that the institution accepted the documents submitted by the student, or by persons and organizations connected with the student.

awardYear
string

The financial aid award year which is the period beginning July 1 and ending June 30 of the following year.

createdByUserId
number <int32>

The last and then first name of the staff member who added or created the item.

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

documentImage
string <byte>

The documents submitted by a student, or by persons and organizations connected with the student.

documentScheduleId
number <int32>

Document Schedule Id

documentStatusId
number <int32>

The status of the document. The list contains the predefined statuses of Requested - Required, Requested - Not Required, Approved, No Further Action, Not Requested, Required, Received but Rejected, Sent, and Not Sent. Any additional items in the lists were defined by your organization.

documentTranscriptRequestId
number <int32>

Document Transcript Request Id

documentTriggerId
number <int32>

Document Trigger Id

documentTypeId
number <int32>

The type of document submitted to the institution.

dueDate
string <date-time>

The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date.

expiresDate
string <date-time>

The date when the group or document is no longer valid. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date. The default is calculated using the value for Default Number of Days to Retain Student Groups on the Options tab for the campus in the Desktop Client (Setup > Campus Location).

imageNowDocId0
string

Image Now Doc Id0

imageNowDocId1
string

Image Now Doc Id1

imageType
string

Image Type

isDocumentAddedManually
boolean

Is Document Added Manually

isPermit
boolean

Is Permit

lastModifiedDateTime
string <date-time>

The date that the item was updated or changed.

lastModifiedUserId
number <int32>

The last and then first name of the person that changed the item.

moduleId
number <int32>

The various categories that pertain to functional areas within an institution. For example, Academic Records, Financial Aid, and so on.

note
string

Area you can use to display or specify comments or additional information.

originalFileName
string

Original File Name

receivedDate
string <date-time>

The date the institution received the documents submitted by the student, or by persons and organizations connected with the student.

requestedDate
string <date-time>

The date when an institution, person, or a student requested documents or information to be submitted for evaluation.

rowVersion
string
scanned
boolean

Scanned

sentDate
string <date-time>

The date when the requested information or document is sent.

studentEnrollmentPeriodId
number <int32>

The code and name of the enrollment.

studentId
number <int32>

Student Id

studentPlacementId
number <int32>

Student Placement Id

workflowInstanceIdentifier
object

Workflow Instance Identifier

object (cmc-nexus-crm-entities-documentTranscriptRequestEntity)
Array of objects (cmc-nexus-crm-entities-studentCourseDocumentPermitEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Task Attachments

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-savetaskattachments-request-payload)
Array of objects (cmc-nexus-crm-entities-documentEntity)
taskId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Task Document

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-updatestudenttaskdocument-request-payload)
object (cmc-nexus-crm-entities-documentEntity)
id
required
number <int32>

Id

approvedDate
string <date-time>

The date that the institution accepted the documents submitted by the student, or by persons and organizations connected with the student.

awardYear
string

The financial aid award year which is the period beginning July 1 and ending June 30 of the following year.

createdByUserId
number <int32>

The last and then first name of the staff member who added or created the item.

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

documentImage
string <byte>

The documents submitted by a student, or by persons and organizations connected with the student.

documentScheduleId
number <int32>

Document Schedule Id

documentStatusId
required
number <int32>

The status of the document. The list contains the predefined statuses of Requested - Required, Requested - Not Required, Approved, No Further Action, Not Requested, Required, Received but Rejected, Sent, and Not Sent. Any additional items in the lists were defined by your organization.

documentTranscriptRequestId
number <int32>

Document Transcript Request Id

documentTriggerId
number <int32>

Document Trigger Id

documentTypeId
required
number <int32>

The type of document submitted to the institution.

dueDate
string <date-time>

The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date.

expiresDate
string <date-time>

The date when the group or document is no longer valid. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date. The default is calculated using the value for Default Number of Days to Retain Student Groups on the Options tab for the campus in the Desktop Client (Setup > Campus Location).

imageNowDocId0
string

Image Now Doc Id0

imageNowDocId1
string

Image Now Doc Id1

imageType
string

Image Type

isDocumentAddedManually
boolean

Is Document Added Manually

isPermit
boolean

Is Permit

lastModifiedDateTime
string <date-time>

The date that the item was updated or changed.

lastModifiedUserId
number <int32>

The last and then first name of the person that changed the item.

moduleId
required
number <int32>

The various categories that pertain to functional areas within an institution. For example, Academic Records, Financial Aid, and so on.

note
string

Area you can use to display or specify comments or additional information.

originalFileName
string

Original File Name

receivedDate
string <date-time>

The date the institution received the documents submitted by the student, or by persons and organizations connected with the student.

requestedDate
string <date-time>

The date when an institution, person, or a student requested documents or information to be submitted for evaluation.

rowVersion
string
scanned
boolean

Scanned

sentDate
string <date-time>

The date when the requested information or document is sent.

studentEnrollmentPeriodId
number <int32>

The code and name of the enrollment.

studentId
number <int32>

Student Id

studentPlacementId
number <int32>

Student Placement Id

workflowInstanceIdentifier
object

Workflow Instance Identifier

object (cmc-nexus-crm-entities-documentTranscriptRequestEntity)
Array of objects (cmc-nexus-crm-entities-studentCourseDocumentPermitEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Upload Document To External Document Management Provider

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-uploaddocumenttoexternaldocumentmanagementprovider-request-payload)
isAutoRedirect
boolean
campusId
number <int32>
studentId
number <int32>
documentId
number <int32>
studentName
string
studentNumber
string
documentTypeName
string
documentTypeCode
string
moduleCode
string
providerDocumentIdentifier
string
vendorCode
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Upload Student Document

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-document-uploadstudentdocument-request-payload)
documentId
number <int32>
documentImage
string <byte>
fileNameWithExtension
string
moduleIdentifier
string
moduleCode
string
moduleName
string
documentTypeCode
string
documentTypeName
string
externalDocumentTypeIdentifier
string
awardYear
string
externalDocumentIdentifier
string
fileBytes
string
fileSize
string
fileTypeIdentifier
string
programVersionCode
string
vendorCode
string
campusCode
string
campusId
number <int32>
crmIdentifier
string
emailAddress
string
studentFirstName
string
studentLastName
string
programCode
string
programName
string
programVersionName
string
startDate
string
studentId
number <int32>
studentNumber
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Task

Check Task Conflict By Date And Time

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-checktaskconflictbydateandtime-request-payload)
isRequestFromMessage
boolean
taskStatusCode
string
crmSuppressFlag
boolean
id
number <int32>

Id

assignedToStaffId
number <int32>

The person assigned to the task. For a new task, the default is your user ID. If you have permission in the policy, the names of other staff members are displayed. If you are filtering on Assigned To, the maximum number of staff members you can select is 50.

attachments
string

Attachments

attachmentsId
number <int32>

Attachments Id

classSectionId
number <int32>

Class Section Id

completedByStaffId
number <int32>

The last and then first name of the staff member who completed the item.

createdByStaffId
number <int32>

The last and then first name of the staff member who added or created the item.

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

emailSubject
string

The text that appears in the subject line of the email. It contains the subject configured by your organization for the type of task and can be edited.

employerContactId
number <int32>

The name of the contact within the organization. If you are selecting a contact in a list, it contains the contacts configured for your institution. If your institution uses the Contact Type/Activities Security to limit access to contacts (Setup > Career Services), the list only contains the contacts you are authorized to select.

employerId
number <int32>

The name of the employer. If you are selecting the employer from a list, it contains the names of all the employers configured for your institution.

employerJobId
number <int32>

The job title with the employer. The list also displays the status of the job. The statuses are Available, Canceled, Closed, Pending, and Unable to Fill. No value in the status column indicates there is no status available for the job.

isActivityNotViewed
boolean

Is Activity Not Viewed

lastModifiedDateTime
string <date-time>

The date that the item was updated or changed.

lastModifiedUserId
number <int32>

The last and then first name of the person that changed the item.

lockedByUserId
number <int32>

Locked By User Id

note
string

Area you can use to display or specify comments or additional information.

organizationContactId
number <int32>

The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution.

organizationId
number <int32>

Specifies the organization for the student that is contacted for the task (such as High School).

previouslyAssignedToStaffId
number <int32>

The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution.

priority
string

The priority of the task. The options are Low, Normal, and High. The default is Normal.

prospectInquiryId
number <int32>

The name of the program and date that the student made the inquiry. The list is only displayed if the student has a CampusNexus Student Status Category of Lead (such as New Lead, Interview Schedule, or Interviewed). For the list to be available, the Track Multiple Lead Inquiries box must also be selected in CampusNexus Student on the Lead Sources Code Setup form (List > Admissions > Lead Sources > Add/Edit Lead Source > Lead Sources Code Setup).

reassignedDate
string <date-time>

The date that the task was reassigned to you.

remindDate
string <date-time>

Remind Date

resultText
string

The outcome of the task. The list is only displayed for a Status of Closed. It contains results defined by your institution.

rowVersion
string
sessionSyCampusId
number <int32>

Session Sy Campus Id

sourceRecordId
number <int32>

Source Record Id

sourceSystem
string

Source System

sourceTable
string

Source Table

studentEnrollmentPeriodId
number <int32>

The code and name of the enrollment.

studentId
number <int32>

The last and then first name of the student.

subject
string

The description of the task. If you are specifying the description, the default is the value that you selected for Task and can be modified.

taskDueDate
string <date-time>

The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date.

taskEndDate
string <date-time>

The date that the item was completed.

taskResultId
number <int32>

The outcome of the task. The list is only displayed for a Status of Closed. It contains results defined by your institution.

taskStartDate
string <date-time>

Task Start Date

taskStatusDate
string <date-time>

The date that the status was last changed.

taskStatusId
number <int32>

The status of the task. If you are selecting a value, the list contains the system statuses of Pending (default), Queued, Closed, Activity Reassigned, and Activity Failed. Any additional items in the lists were defined by your organization.

taskTemplateId
number <int32>

The task that must be performed. A task corresponds to an activity in the Desktop Client. It is the description given to the type of task when it was configured by your institution.

taskTypeId
number <int32>

The type of event associated with the task. They are defined by the system and are selected for task type when it is configured by your institution.

templateTextFile
string

Template Text File

workflowInstanceIdentifier
object

Workflow Instance Identifier

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Task

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Task

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-delete-request-payload)
isRequestFromMessage
boolean
taskStatusCode
string
crmSuppressFlag
boolean
id
number <int32>

Id

assignedToStaffId
number <int32>

The person assigned to the task. For a new task, the default is your user ID. If you have permission in the policy, the names of other staff members are displayed. If you are filtering on Assigned To, the maximum number of staff members you can select is 50.

attachments
string

Attachments

attachmentsId
number <int32>

Attachments Id

classSectionId
number <int32>

Class Section Id

completedByStaffId
number <int32>

The last and then first name of the staff member who completed the item.

createdByStaffId
number <int32>

The last and then first name of the staff member who added or created the item.

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

emailSubject
string

The text that appears in the subject line of the email. It contains the subject configured by your organization for the type of task and can be edited.

employerContactId
number <int32>

The name of the contact within the organization. If you are selecting a contact in a list, it contains the contacts configured for your institution. If your institution uses the Contact Type/Activities Security to limit access to contacts (Setup > Career Services), the list only contains the contacts you are authorized to select.

employerId
number <int32>

The name of the employer. If you are selecting the employer from a list, it contains the names of all the employers configured for your institution.

employerJobId
number <int32>

The job title with the employer. The list also displays the status of the job. The statuses are Available, Canceled, Closed, Pending, and Unable to Fill. No value in the status column indicates there is no status available for the job.

isActivityNotViewed
boolean

Is Activity Not Viewed

lastModifiedDateTime
string <date-time>

The date that the item was updated or changed.

lastModifiedUserId
number <int32>

The last and then first name of the person that changed the item.

lockedByUserId
number <int32>

Locked By User Id

note
string

Area you can use to display or specify comments or additional information.

organizationContactId
number <int32>

The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution.

organizationId
number <int32>

Specifies the organization for the student that is contacted for the task (such as High School).

previouslyAssignedToStaffId
number <int32>

The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution.

priority
string

The priority of the task. The options are Low, Normal, and High. The default is Normal.

prospectInquiryId
number <int32>

The name of the program and date that the student made the inquiry. The list is only displayed if the student has a CampusNexus Student Status Category of Lead (such as New Lead, Interview Schedule, or Interviewed). For the list to be available, the Track Multiple Lead Inquiries box must also be selected in CampusNexus Student on the Lead Sources Code Setup form (List > Admissions > Lead Sources > Add/Edit Lead Source > Lead Sources Code Setup).

reassignedDate
string <date-time>

The date that the task was reassigned to you.

remindDate
string <date-time>

Remind Date

resultText
string

The outcome of the task. The list is only displayed for a Status of Closed. It contains results defined by your institution.

rowVersion
string
sessionSyCampusId
number <int32>

Session Sy Campus Id

sourceRecordId
number <int32>

Source Record Id

sourceSystem
string

Source System

sourceTable
string

Source Table

studentEnrollmentPeriodId
number <int32>

The code and name of the enrollment.

studentId
number <int32>

The last and then first name of the student.

subject
string

The description of the task. If you are specifying the description, the default is the value that you selected for Task and can be modified.

taskDueDate
string <date-time>

The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date.

taskEndDate
string <date-time>

The date that the item was completed.

taskResultId
number <int32>

The outcome of the task. The list is only displayed for a Status of Closed. It contains results defined by your institution.

taskStartDate
string <date-time>

Task Start Date

taskStatusDate
string <date-time>

The date that the status was last changed.

taskStatusId
number <int32>

The status of the task. If you are selecting a value, the list contains the system statuses of Pending (default), Queued, Closed, Activity Reassigned, and Activity Failed. Any additional items in the lists were defined by your organization.

taskTemplateId
number <int32>

The task that must be performed. A task corresponds to an activity in the Desktop Client. It is the description given to the type of task when it was configured by your institution.

taskTypeId
number <int32>

The type of event associated with the task. They are defined by the system and are selected for task type when it is configured by your institution.

templateTextFile
string

Template Text File

workflowInstanceIdentifier
object

Workflow Instance Identifier

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Task

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Batch Filtered Tasks

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-getbatchfilteredtasks-request-payload)
batchTaskMaintenanceType
number <int32>
studentId
number <int32>
campusList
Array of numbers <int32> [ items <int32 > ]
taskList
Array of numbers <int32> [ items <int32 > ]
taskCategoryList
Array of numbers <int32> [ items <int32 > ]
staffAssignedToList
Array of numbers <int32> [ items <int32 > ]
taskStatusList
Array of numbers <int32> [ items <int32 > ]
taskResultList
Array of numbers <int32> [ items <int32 > ]
stateList
Array of numbers <int32> [ items <int32 > ]
studentGroupList
Array of numbers <int32> [ items <int32 > ]
lockedByStaffList
Array of numbers <int32> [ items <int32 > ]
taskFromDueDate
string <date-time>
taskToDueDate
string <date-time>
topFilteredRecords
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Staff Messages

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-getstaffmessages-request-payload)
fromDueDate
string
toDueDate
string
staffIds
Array of numbers <int32> [ items <int32 > ]
campusIds
Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Message

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-getstudentmessage-request-payload)
staffIdList
Array of numbers <int32> [ items <int32 > ]
campusIdList
Array of numbers <int32> [ items <int32 > ]
advisorType
string
studentListShow
string
staffIdXml
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Mark Message Read

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-markmessageread-request-payload)
eventId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Task

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-save-request-payload)
isRequestFromMessage
boolean
taskStatusCode
string
crmSuppressFlag
boolean
id
number <int32>

Id

assignedToStaffId
number <int32>

The person assigned to the task. For a new task, the default is your user ID. If you have permission in the policy, the names of other staff members are displayed. If you are filtering on Assigned To, the maximum number of staff members you can select is 50.

attachments
string

Attachments

attachmentsId
number <int32>

Attachments Id

classSectionId
number <int32>

Class Section Id

completedByStaffId
number <int32>

The last and then first name of the staff member who completed the item.

createdByStaffId
number <int32>

The last and then first name of the staff member who added or created the item.

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

emailSubject
string

The text that appears in the subject line of the email. It contains the subject configured by your organization for the type of task and can be edited.

employerContactId
number <int32>

The name of the contact within the organization. If you are selecting a contact in a list, it contains the contacts configured for your institution. If your institution uses the Contact Type/Activities Security to limit access to contacts (Setup > Career Services), the list only contains the contacts you are authorized to select.

employerId
number <int32>

The name of the employer. If you are selecting the employer from a list, it contains the names of all the employers configured for your institution.

employerJobId
number <int32>

The job title with the employer. The list also displays the status of the job. The statuses are Available, Canceled, Closed, Pending, and Unable to Fill. No value in the status column indicates there is no status available for the job.

isActivityNotViewed
boolean

Is Activity Not Viewed

lastModifiedDateTime
string <date-time>

The date that the item was updated or changed.

lastModifiedUserId
number <int32>

The last and then first name of the person that changed the item.

lockedByUserId
number <int32>

Locked By User Id

note
string

Area you can use to display or specify comments or additional information.

organizationContactId
number <int32>

The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution.

organizationId
number <int32>

Specifies the organization for the student that is contacted for the task (such as High School).

previouslyAssignedToStaffId
number <int32>

The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution.

priority
string

The priority of the task. The options are Low, Normal, and High. The default is Normal.

prospectInquiryId
number <int32>

The name of the program and date that the student made the inquiry. The list is only displayed if the student has a CampusNexus Student Status Category of Lead (such as New Lead, Interview Schedule, or Interviewed). For the list to be available, the Track Multiple Lead Inquiries box must also be selected in CampusNexus Student on the Lead Sources Code Setup form (List > Admissions > Lead Sources > Add/Edit Lead Source > Lead Sources Code Setup).

reassignedDate
string <date-time>

The date that the task was reassigned to you.

remindDate
string <date-time>

Remind Date

resultText
string

The outcome of the task. The list is only displayed for a Status of Closed. It contains results defined by your institution.

rowVersion
string
sessionSyCampusId
number <int32>

Session Sy Campus Id

sourceRecordId
number <int32>

Source Record Id

sourceSystem
string

Source System

sourceTable
string

Source Table

studentEnrollmentPeriodId
number <int32>

The code and name of the enrollment.

studentId
number <int32>

The last and then first name of the student.

subject
string

The description of the task. If you are specifying the description, the default is the value that you selected for Task and can be modified.

taskDueDate
string <date-time>

The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date.

taskEndDate
string <date-time>

The date that the item was completed.

taskResultId
number <int32>

The outcome of the task. The list is only displayed for a Status of Closed. It contains results defined by your institution.

taskStartDate
string <date-time>

Task Start Date

taskStatusDate
string <date-time>

The date that the status was last changed.

taskStatusId
number <int32>

The status of the task. If you are selecting a value, the list contains the system statuses of Pending (default), Queued, Closed, Activity Reassigned, and Activity Failed. Any additional items in the lists were defined by your organization.

taskTemplateId
number <int32>

The task that must be performed. A task corresponds to an activity in the Desktop Client. It is the description given to the type of task when it was configured by your institution.

taskTypeId
number <int32>

The type of event associated with the task. They are defined by the system and are selected for task type when it is configured by your institution.

templateTextFile
string

Template Text File

workflowInstanceIdentifier
object

Workflow Instance Identifier

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Task

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-savenew-request-payload)
isRequestFromMessage
boolean
taskStatusCode
string
crmSuppressFlag
boolean
id
number <int32>

Id

assignedToStaffId
number <int32>

The person assigned to the task. For a new task, the default is your user ID. If you have permission in the policy, the names of other staff members are displayed. If you are filtering on Assigned To, the maximum number of staff members you can select is 50.

attachments
string

Attachments

attachmentsId
number <int32>

Attachments Id

classSectionId
number <int32>

Class Section Id

completedByStaffId
number <int32>

The last and then first name of the staff member who completed the item.

createdByStaffId
number <int32>

The last and then first name of the staff member who added or created the item.

createdDateTime
string <date-time>

The date when the item or person was added or the status change was entered.

emailSubject
string

The text that appears in the subject line of the email. It contains the subject configured by your organization for the type of task and can be edited.

employerContactId
number <int32>

The name of the contact within the organization. If you are selecting a contact in a list, it contains the contacts configured for your institution. If your institution uses the Contact Type/Activities Security to limit access to contacts (Setup > Career Services), the list only contains the contacts you are authorized to select.

employerId
number <int32>

The name of the employer. If you are selecting the employer from a list, it contains the names of all the employers configured for your institution.

employerJobId
number <int32>

The job title with the employer. The list also displays the status of the job. The statuses are Available, Canceled, Closed, Pending, and Unable to Fill. No value in the status column indicates there is no status available for the job.

isActivityNotViewed
boolean

Is Activity Not Viewed

lastModifiedDateTime
string <date-time>

The date that the item was updated or changed.

lastModifiedUserId
number <int32>

The last and then first name of the person that changed the item.

lockedByUserId
number <int32>

Locked By User Id

note
string

Area you can use to display or specify comments or additional information.

organizationContactId
number <int32>

The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution.

organizationId
number <int32>

Specifies the organization for the student that is contacted for the task (such as High School).

previouslyAssignedToStaffId
number <int32>

The name of the contact within the institution. If you are selecting a contact in a list, it contains the contacts configured for your institution.

priority
string

The priority of the task. The options are Low, Normal, and High. The default is Normal.

prospectInquiryId
number <int32>

The name of the program and date that the student made the inquiry. The list is only displayed if the student has a CampusNexus Student Status Category of Lead (such as New Lead, Interview Schedule, or Interviewed). For the list to be available, the Track Multiple Lead Inquiries box must also be selected in CampusNexus Student on the Lead Sources Code Setup form (List > Admissions > Lead Sources > Add/Edit Lead Source > Lead Sources Code Setup).

reassignedDate
string <date-time>

The date that the task was reassigned to you.

remindDate
string <date-time>

Remind Date

resultText
string

The outcome of the task. The list is only displayed for a Status of Closed. It contains results defined by your institution.

rowVersion
string
sessionSyCampusId
number <int32>

Session Sy Campus Id

sourceRecordId
number <int32>

Source Record Id

sourceSystem
string

Source System

sourceTable
string

Source Table

studentEnrollmentPeriodId
number <int32>

The code and name of the enrollment.

studentId
number <int32>

The last and then first name of the student.

subject
string

The description of the task. If you are specifying the description, the default is the value that you selected for Task and can be modified.

taskDueDate
string <date-time>

The date the task or a document is due. For a new task, the default is today. If you are specifying the value, specify the value in the format MM/DD/YYYY or click the calendar button to select the date.

taskEndDate
string <date-time>

The date that the item was completed.

taskResultId
number <int32>

The outcome of the task. The list is only displayed for a Status of Closed. It contains results defined by your institution.

taskStartDate
string <date-time>

Task Start Date

taskStatusDate
string <date-time>

The date that the status was last changed.

taskStatusId
number <int32>

The status of the task. If you are selecting a value, the list contains the system statuses of Pending (default), Queued, Closed, Activity Reassigned, and Activity Failed. Any additional items in the lists were defined by your organization.

taskTemplateId
number <int32>

The task that must be performed. A task corresponds to an activity in the Desktop Client. It is the description given to the type of task when it was configured by your institution.

taskTypeId
number <int32>

The type of event associated with the task. They are defined by the system and are selected for task type when it is configured by your institution.

templateTextFile
string

Template Text File

workflowInstanceIdentifier
object

Workflow Instance Identifier

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Schedule Task For Group

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (crm-task-scheduletaskforgroup-request-payload)
object (cmc-nexus-crm-entities-taskEntity)
studentGroupId
number <int32>
assignCurrentEnrollment
boolean
employerGroupId
number <int32>
isScheduleTaskForEmployerGroup
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Reassigned Tasks Viewed Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

payload
any (crm-task-updatereassignedtasksviewedstatus-request-payload)

Responses

Request samples

Content type
application/json
{
  • "payload": null
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}