leads

GET leads/get_cancelled — This method returns all leads which are in life cycle state state "Cancelled". Multiple leads are returned by each call. Note that identifiers are optional for this method.
GET leads/get_close_to_estimated_completion_time — This method returns all leads that are close to estimated completion time. Multiple leads are returned by each call. Note that identifiers are optional for this method.
GET leads/get_in_progress — This method returns all leads which are in life cycle state state "In Progress". Multiple leads are returned by each call. Note that identifiers are optional for this method.
GET leads/get_lost_leads — This method returns all leads which are in life cycle state state "Lost". Multiple leads are returned by each call. Note that identifiers are optional for this method.
GET leads/get_overdue — This method returns all leads which are not completed and are past their expected completion time. Multiple leads are returned by each call. Note that identifiers are optional for this method.
GET leads/get_pending — This method returns all leads which are in pending life cycle state. Multiple leads are returned by each call. Note that identifiers are optional for this method.
GET leads/get_won_leads — This method returns all leads which are in life cycle state state "Won". Multiple leads are returned by each call. Note that identifiers are optional for this method.
GET leads/list — This method returns information related with leads. Multiple leads are returned by each call
GET leads/show — This method returns information related with a lead. A single lead is returned by each call
POST leads/cancel — This method cancels a Lead but only as long as the Lead in not in life cycle state Won or Lost. A single lead can be cancelled by each call
POST leads/create — This method creates a lead. Single lead can be created by each call.
POST leads/lost — This method marks a Lead as Lost but only as long as the Lead is in Pending or In Progress life cycle states. A single lead can be marked as lost by each call
POST leads/start_progress — This method starts the progress of a lead in Pending state. A single lead's progress can be started by each call
POST leads/update — This method updates leads. A single lead can be updated by each call and only if it is not with status Won or Lost. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
POST leads/win — This method marks a Lead as Won but only as long as the Lead is In Progress life cycle states. A single lead can be won by each call
leads/configuration
- GET leads/configuration/categories/list — This method returns the lead categories that are allowed to be used by leads of a specific type. Multiple lead categories are returned by each call
- GET leads/configuration/importance_levels/list — This method returns the importance levels that are allowed to be used by leads of any type. Only importance levels defined in the active Lead Definitions and set as Supported are retrieved. Multiple importance levels are returned by each call
- GET leads/configuration/statuses/list — This method returns the statuses that are allowed to be used by leads of specific type. Multiple statuses are returned by each call
- GET leads/configuration/services/list — This method returns the services that are allowed to be used by leads of specific type. Multiple services are returned by each call
- GET leads/configuration/activity_types/list — This method returns the activity types that are allowed to be used by leads of specific type. Multiple activity types are returned by each call
- GET leads/configuration/physical_goods/list — This method returns the physical goods that are allowed to be used by leads of specific type. Multiple physical goods are returned by each call
- GET leads/configuration/source_types/list — This method returns the source types that are allowed to be used by leads of any type. All Source Types defined in the active Lead Definitions are retrieved if no type is defined. Any custom Source Type which does not have a label is not retrieved. Multiple source types are returned by each call
- GET leads/configuration/competitors/list — This method returns the competitors that are allowed to be used by leads of any or all types. All Competitors defined in the active Lead Definitions are retrieved if no type is defined. Multiple competitors are returned by each call
- GET leads/configuration/priority_levels/list — This method returns the priority levels that are allowed to be used by leads of any type. Only priority levels defined in the active Lead Definitions and set as Supported are retrieved. Multiple priority levels are returned by each call
- GET leads/configuration/types/list — This method returns the lead types that are allowed to be used in the system as these are defined in active Lead Definitions. Multiple lead types are returned by each call.
- GET leads/configuration/products/list — This method returns the products that are allowed to be used by leads of specific type. Multiple services are returned by each call
- GET leads/configuration/lost_reasons/list — This method returns the lost reasons that are allowed to be used by leads of any type. All Lost Reasons defined in the active Lead Definitions are retrieved if no type is defined. Multiple lost reasons are returned by each call
- GET leads/configuration/pipelines/list — This method returns the statuses included in pipelines. Either the pipeline of a specific lead type, or all pipelines. Multiple statuses are returned by each call