/
PUT /prospects/:id
The following macros are not currently supported in the header:
  • style

PUT /prospects/:id

Nov 25, 2014

Resource URL

Update a prospect (sale) object.

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

Parameters

Table of allowed parameters.

title

string

A new title for your prospect.

comments

string

Comments stored against the prospect.

affiliation_id

unsigned int

An id of an affiliation linked to the prospect. Note, this MUST point to a valid affiliation.

staff_id

unsigned int

The staff member's id you wish to be stored against the prospect. Note, this MUST point to a valid staff user.

value

decimal

The value of the say. e.g, 2000.00

success

enum(yes,no)

 

_fields

partial string

Allows 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.