SEservicechannel
Proposals

Reject a proposal

Updates the status of the specified proposal to Rejected. <br />You can send a proposal rejection notification to a specific user or to all users from the Proposals/Proposal Alerts list.  • ProviderEmail and UserEmail. Use these parameters to send a proposal rejection notification to a specific user. If passed, any of these parameters prevails over useProposalAlertEmails. In case you pass a value to the ProviderEmail or UserEmail parameter in the request body and set useProposalAlertEmails to true, a notification is sent to the specified email address, while users from the Proposals/Proposal Alerts list are not notified.  • useProposalAlertEmails. Set this parameter to true to send proposal rejection notifications to all users listed in the Proposals/Proposal Alerts section of Dispatch Preferences. <br />Note: This method is only available to subscriber users. <br />Example Request

            PUT /proposals/{proposalId}/reject
            { 
              "Comment": "Rejected due to the high costs",
              "ProviderEmail": "ifixxservices@gmail.com",
              "UserEmail": "cajunsoulrestaurant@gmail.com",
              "RejectReasonCodeId": 4,
              "ActionSource": "Standard",
              "Actor": "Peter Cale",
              "AttachmentstoWO": false,
              "PinNote": true 
             }
put/proposals/{proposalId}/reject

Request

Path parameters

proposalIdinteger required

The unique numeric identifier of the proposal to reject.

Query parameters

useProposalAlertEmailsboolean

Defines if a proposal rejection notification is sent to all users listed in the Proposals/Proposal Alerts section of Dispatch Preferences. If the parameter value is true, users from the Proposals/Proposal Alerts list get a notification if the ProviderEmail and UserEmail parameters are not passed. If set to false or not passed, this parameter is ignored.

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 Rejected, 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.