SEservicechannel
Proposals

Put a proposal on hold

Updates the status of the specified proposal to On Hold. <br />Note: This method is only available to subscriber users. <br />Example Request

            PUT /proposals/{proposalId}/onhold
            { 
              "Comment": "Putting it on hold to analyze the materials costs",
              "ProviderEmail": "ifixxservices@gmail.com",
              "UserEmail": "cajunsoulrestaurant@gmail.com",
              "Actor": "Peter Cale",
              "PinNote": true
             }
put/proposals/{proposalId}/onhold

Request

Path parameters

proposalIdinteger required

The unique numeric identifier of the proposal to put on hold.

Request body

Commentstring

Comment on the proposal status update. The comment is added to the work order note.

ProviderEmailstring

Provider’s email address to which a notification about the proposal status change is sent. The default is the email address of the provider the proposal is assigned to.

UserEmailstring

User’s email address to which a notification about the proposal status change is sent. The default is the email address of the current user.

RejectReasonCodeIdinteger

Numeric identifier of the reason for rejecting the proposal. Pass value to this parameter when sending the PUT /proposals/{proposalId}/reject request. To retrieve a list of rejection reason codes and their descriptions, use the GET /proposals/RejectionReasons method.

ActionSource'Standard' | 'DecisionEngine'

Defines whether users take a standard action (approve or reject) or an action recommended by Decision Engine. Possible values: Standard, DecisionEngine.

ReasonStringstring

Reason for approving the proposal. Pass value to this parameter when sending the PUT /proposals/{proposalId}/approve request. The entered reason is added to the work order note.

Actorstring

User who is taking action on the proposal.

AttachmentstoWOboolean

Moves attachments from an approved proposal to the associated work order. Only possible upon final approval.

PinNoteboolean

When set to true, the system adds the proposal Comment as a pinned note on the associated work order. When set to false, the proposal Comment is added as an ordinary note on the associated work order. Note: To pin a proposal comment, there must be an associated work order.

Response

The proposal status is set to On Hold, users are notified based on the passed parameters, and the values of the specified parameters are updated.<br/>The response is intentionally blank.

Changes

No recorded changes to this operation across all 1 revision of this API.