The following macros are not currently supported in the header:
- style
Prospects (Sales)
A prospect (or sale) in AffinityLive belongs against a company record. You don't create prospects and then turn them into client companies, rather you take a company (which may have a status of "Lead" or "Suspect") and add some prospective work/business against it.
TYPE | RESOURCE | DESCRIPTION |
---|---|---|
GET | /prospects | Returns a list of prospects. |
GET | /prospects/count | Returns the total number of prospects. |
GET | /prospects/:id | Returns a specific prospect identified by its id. |
GET | /prospects/:id/status | Returns the prospect's status. |
GET | /prospects/:id/extensions/values | Returns an array of extension values for the given prospect |
PUT | /prospects/:id | Updates a given prospect |
PUT | /prospects/:id/extensions/values/:extension_value_id | Update a given extension value |
GET | /prospects/:id/profiles/values | Returns an array of profile values for the prospect. |
PUT | /prospects/:id/profiles/values/:profile_value_id | Update an existing profile value for the prospect. |
GET | /prospects/:id/progressions | Returns an array of available progressions for the prospect. |
[PUT|POST] | /prospects/:id/progressions/:progression_id/auto | Runs a status update for the given progression on the given prospect. |
GET | /prospects/statuses | Returns an array of available statuses for prospect. |
GET | /prospects/types | Returns an array of available types for prospect. |
GET | /prospects/extensions/fields | Returns an array of extension fields for prospect. |
POST | /prospects/:prospect_id/extensions/fields/:extension_field_id | Creates an extension value for a prospect. |
GET | /prospects/profiles/fields | Returns an array of profile fields for prospect. |
POST | /prospects/:prospect_id/profiles/fields/:profile_field_id | Creates a profile value for a prospect. |
GET | /prospects/:prospect_id/collections | Returns a list of resource(attachment) collections for the given prospect. |
POST | /prospects/:prospect_id/collections/:collection_id/resources | Uploads resource(attachment) to the given collection. |