Application & Process Automation

Getting Started
Authentication & Access
Accounts with Multi-Factor Authentication
Using method GetPrograms
Common Usage Scenarios
Create and Submit a Project
Add/Change Data in an Existing Project
Daily Polling for Project Changes
Troubleshooting
Using Custom IDs
API Method Reference
GetPrograms
URL Format
Response
XML Attributes
Sample Code
GetForms
URL Format
Response
Forms Attributes
AvailableInStatuses and LeadsToStatus
Status Attributes
Sample Code
GetFormSchema
V1 Response
V2 Response
Sample Code
GetProjects
V1 Response
V2 Response
V3 Response
Sample Code
GetProjectsByNumber
V1 Response
V2 Response
Sample Request
Sample Code
GetProjectsByData
Sample Request
Request XML Nodes and Attributes
V1 Response
V2 Response
CreateNewProject
Sample Response
Response XML Attributes
Sample Code
GetAllProjectData - Admin only
Sample Response
XML Attributes
Sample Code
GetProjectData
Sample Response
XML Attributes
Sample Code
SetProjectData
Sample Request
Request XML Attributes
Sample Response
Response XML Attributes
Sample Code
GetActiveAttachment
URL Format
Sample Code
GetAttachmentAsAdmin – Admin only
URL Format
SetProjectAttachment
Identifying attachment file types
URL Format
Sample Response
Response XML Attributes
Sample Code
SetAttachmentMetadata
Sample Request
Request XML Attributes
Sample Response
Response XML Attributes
Sample Code
GetAttachmentMetadata
URL Format
Sample Response
Response XML Attributes
Sample Code
SubmitProject
URL Format
Sample Response
Response XML Attributes
Sample Code
GetStatusList – Admin only
Sample Code
URL Format
Sample Response
Response XML Attributes
GetCustomListChoices
URL Format
Sample Response
Response XML Attributes
GetProjectStatusHistory – Admin only
URL Format
Sample Response
Response XML Attributes
Sample Code
SetProjectStatus – Admin only
URL Format
Sample Response
Response XML Attributes
Sample Code
GetExportProject – Admin only
Response XML Attributes
Sample Code
URL Format
Sample Response
CreateMfaSessionToken
URL Format
Sample Request
Request XML Attributes
Sample Response
Response XML Attributes
Sample Code
DeleteMfaSessionToken
URL Format
Sample Response
Sample Code
SetAssignee
URL Format
Sample Request
Request XML Attributes
Sample Response
Response XML Attributes
SetProjectOwner
URL Format
Sample Request
Request XML Attributes
Sample Response
Response XML Attributes
GetInquiryThreads – Admin Only
GetNotesInInquiryThread – Admin Only
SetInquiryNote – Admin Only
SetInquiryThreadStatus – Admin Only
SetInquiryThreadExternalId – Admin Only
SetProjectStatusReportAs – Admin only
Code Samples
EncodeAuthorizationHeader
MakeGetRequest
MakePostRequest
MakeGetFileRequest
MakeDeleteRequest
PowerShell

SetInquiryThreadExternalId – Admin Only

Sets the external ID of a given Project Inquiries thread. External IDs are primarily used for Connection interactions, or otherwise coordinating PowerClerk’s inquiry records with an external system for tracking inquiry threads. Requires admin write access to the thread’s associated project.
 
HTTP verb: POST (Does not require a request payload)
Required inputs: ProgramId, ThreadID, ExternalId
 

Path Parameters
Path Parameters Description
ProgramId The ID of the program.
ThreadID The ID of the thread to retrieve.
ExternalId The ExternalId from the external system the Connection interacts with.

URL Format

Format: https://{BaseURL}/Programs/{ProgramId}/InquiryThreads/{ThreadId}/ExternalId/{ExternalId}
 
Sample: https://{BaseURL}/Programs/1HF29X4P/InquiryThreads/N58VKF4CSNRP/ExternalId/INQ_45501

Sample Response


<InquiryThreadsResponse>
    <InquiryThreads>
        <InquiryThread ProgramId="1HF29X4P" ProjectId="M4AN7RYRSYZE" ThreadId="HJAY284N7FTC" ExternalId="Example External Id" Title="Example Thread 1" CategoryId="Example Category" Status="Open" LastActiveTimestamp="2023-03-09T12:46:37-08:00"/>
        <InquiryThread ProgramId="1HF29X4P" ProjectId="M4AN7RYRSYZE" ThreadId="T0V8SDJ6DTMH" Title="Example Thread 2" CategoryId="Example Category" Status="Open" LastActiveTimestamp="2023-03-09T12:46:37-08:00"/>
    </InquiryThreads>
</InquiryThreadsResponse>

What’s Next?

SetProjectStatusReportAs– Admin only