Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Resource URL

Update a prospect (sale) object.

PUT /prospects/:id
POST /prospects/:id?_method=put

Parameters

Table of allowed parameters.

titlestringA new title for your prospect.
commentsstringComments stored against the prospect.
affiliation_idunsigned intAn id of an affiliation linked to the prospect. Note, this MUST point to a valid affiliation.
staff_idunsigned intThe staff member's id you wish to be stored against the prospect. Note, this MUST point to a valid staff user.
valuedecimalThe value of the say. e.g, 2000.00
successenum(yes,no) 
_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response. For more information see handling the response below.

Handling the response

Returns the updated prospect. Please see get prospect for details regarding handling of the response and requesting specific fields.

  • No labels