CRM in Cloud Web API documentations

Security

This controller works under the system security rules and constraints.
For more details, refer to the Authentication section

Note

The following guidelines are intended to illustrate the features and features of this Web API controller.

Aliases

This controller can be invoked by other names besides the default one.

This means that, referring to the routing grammar ({schema}://{host}/api/{version}/{controller}/{details}/{action}/{id}?{querystring}) it is possible to use a different fragment for the {controller} component.

Below is the list of these aliases for the fragment {controller}, sorted by suggested preference of use.

Alias	Path
Leads	/api/v1/Leads
Lead	/api/v1/Lead

Authentication

JWT Token

In order to invoke the REST API, it is necessary to obtain an authentication token via the appropriate service /Auth/Login

For more details, please see the appropriate section of the documentations.

Bearer Authentication

Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens.

For more details, please see the appropriate section of the documentations.

Identification of the calling application

Some of the REST API functions can only be used if (in addition to proper user authentication) a declaration of the calling application is also performed.

For more details, please see the appropriate section of the documentations.

Actions & Paths

These are the REST actions that can be performed via the Web API infrastructure.
The actions are grouped by "topic".
Click on a "topic" to view the different actions contained in it.

Each action corresponds to a method in the class of the Web API controller, and a set of routing paths that can be used to invoke it.

Explore by topics

Topic name	Most commonly used actions
CRUD	/api/v1/Lead/CreateOrUpdate /api/v1/Lead/ /api/v1/Lead/Exists /api/v1/Lead/ /api/v1/Lead/Humanize /api/v1/Lead/GetFull /api/v1/Lead/GetNewInstance
Multiple CRUD	/api/v1/Lead/MultipleDelete /api/v1/Lead/MultipleExists /api/v1/Lead/MultipleGet
Activities	/api/v1/Lead/Activities /api/v1/Lead/Activities/Count /api/v1/Lead/ActivitiesIds
Documents	/api/v1/Lead/Documents /api/v1/Lead/DocumentsIds /api/v1/Lead/Documents/Count
External References	/api/v1/Lead/SearchIdsByExternalReference /api/v1/Lead/GetByExternalReference /api/v1/Lead/DeleteByExternalReference /api/v1/Lead/MapByExternalReference /api/v1/Lead/ResetExternalReferences /api/v1/Lead/UnmapByExternalReference /api/v1/Lead/GetIdsMappedByExternalReference /api/v1/Lead/GetItemsMappedByExternalReference /api/v1/Lead/GetIdsNotMappedByExternalReference /api/v1/Lead/GetIdsByExternalReference /api/v1/Lead/GetItemsNotMappedByExternalReference
Flow	/api/v1/Lead/Flows /api/v1/Lead/FlowsIds /api/v1/Lead/Flows/Count
Lists	/api/v1/Lead/Lists /api/v1/Lead/ListsIds /api/v1/Lead/ListsCount
Mailings	/api/v1/Lead/Mailings /api/v1/Lead/MailingsIds /api/v1/Lead/MailingsCount
Misc	/api/v1/Lead/Convert /api/v1/Lead/ConvertToCompany /api/v1/Lead/ConvertToContact /api/v1/Lead/ConvertToCompanyNaturalPerson /api/v1/Lead/ConvertToCompanyWithContact /api/v1/Lead/Recover /api/v1/Lead/ResolveCustomerToken /api/v1/Lead/Location /api/v1/Lead/Templates /api/v1/Lead/HtmlPreview /api/v1/Lead/GetDownloadUrl /api/v1/Lead/Archive /api/v1/Lead/Photo /api/v1/Lead/GetSample /api/v1/Lead/GetBoDeleteModes /api/v1/Lead/FreeFields /api/v1/Lead/Recent /api/v1/Lead/GetHash /api/v1/Lead/PrintableFields
OData	/api/v1/Lead/SearchIds /api/v1/Lead/Search /api/v1/Lead/Count
Opportunities	/api/v1/Lead/Opportunities /api/v1/Lead/OpportunitiesIds /api/v1/Lead/Opportunities/Count
Preview	/api/v1/Lead/Previews /api/v1/Lead/Preview
Swagger	/api/v1/Lead/GetPolymorphicSchema /api/v1/Lead/GetStandardSchema /api/v1/Lead/GetSwagger

GET: /api/v1/Lead/

Routing template:

/api/{version}/Lead/

Produces:

HTTP 200: Int64 as application/json
HTTP 200: Int64 as text/json
HTTP 200: Int64 as application/xml
HTTP 200: Int64 as text/plain
HTTP 200: Int64 as application/octet-stream

Name	Type	Required	In	Features
id	integer	YES	Path	Format: int64
template	string	NO	Query
request	LeadPrintableRequest	NO	Query

Name	Type	Required	In	Features
externalReference	string	NO	Query
excludeDeletedItems	boolean	NO	Query

Name	Type	Required	In	Features
serializePropertiesAsDictionary	boolean	NO	Query	Default: True
honorAcceptLanguageHeader	boolean	NO	Query	Default: False
generateSample	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True
includeExplicitlyDeclaredVirtualProperties	boolean	NO	Query	Default: False

Name	Type	Required	In	Features
force	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
includeFull	boolean	NO	Query	Default: True
includeNesting	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
filter	string	NO	Query
orderBy	string	NO	Query
skip	integer	NO	Query	Format: int64
top	integer	NO	Query	Format: int64
select	string	NO	Query

Name	Description
ActionResultDTO	Action Result
ActivityBOActivityRelationDTO	Activity BO Activity Relation
ActivityBOHourBandDTO	Activity BO Hour Band
ActivityCostBOPriceDetailDTO	Activity Cost BO Price Detail
ActivityDTO	Activity
ActivityEMailDataDTO	Activity EMail Data
ActivityFaxDataDTO	Activity Fax Data
ActivityPriorities	Activity Priorities
ActivitySource	Activity Source
ActivityStates	Activity States
ActivityType	Activity Type
AddressAccuracy	Address Accuracy
AlarmActionType	Alarm Action Type
AlarmDTO	Alarm
AlarmNotificationDTO	Alarm Notification
AlarmTimeValueType	Alarm Time Value Type
AnagraphicStatus	Anagraphic Status
ApprovedStatus	Approved Status
BoDeleteMode	Bo Delete Mode
BusinessObjectType	Business Object Type
CRMTables	CRM Tables
CrossActivityWith	Cross Activity With
DefaultCodeType	Default Code Type
DefaultDocumentCategories	Default Document Categories
DeleteItemResult	Delete Item Result
DirectionDTO	Direction
DTOPropertyUsage	DTO Property Usage
EMailNormalizedDTO	EMail Normalized
EMailNormalizeType	EMail Normalize Type
ExistsItemResult	Exists Item Result
ExternalReferenceDTO	External Reference
FileCrossAttributes	File Cross Attributes
FileCrossDTO	File Cross
FileCrossTypes	File Cross Types
FilePreview	File Preview
FlowDTO	Flow
FlowLinkDTO	Flow Link
FlowLogDTO	Flow Log
FlowStepResult	Flow Step Result
FreeFieldsBOItemDTO	Free Fields BO Item
FreeFieldsBOItemLocalizingDTO	Free Fields BO Item Localizing
FreeFieldsBOTreeItemDTO	Free Fields BO Tree Item
FreeFieldsType	Free Fields Type
GeoDTO	Geo
GetIdsMappedByExternalReferenceRequest	Get Ids Mapped By External Reference Request
GetItemResult`1[]	Get Item Result`1
GetItemsMappedByExternalReferenceRequest	Get Items Mapped By External Reference Request
Gravity	Gravity
InfluencerRoleType	Influencer Role Type
JToken	J Token
LeadConversionType	Lead Conversion Type
LeadDTO	Lead
LeadPrintableRequest	Lead Printable Request
LinkItem	Link Item
LiquidStruct	Liquid Struct
ListDTO	List
ListMailingListRightsDTO	List Mailing List Rights
LocalizeType	Localize Type
LocalizingDTO	Localizing
LocationDTO	Location
MailAddressDTO	Mail Address
MailingDeliveryDTO	Mailing Delivery
MailingListRightsDTO	Mailing List Rights
MailListStatus	Mail List Status
MultipleDeleteModel	Multiple Delete Model
MultipleExistsModel	Multiple Exists Model
MultipleGetModel	Multiple Get Model
NormalizerNormalizeAddressDTO	Normalizer Normalize Address
NormalizerNormalizeCityDTO	Normalizer Normalize City
OpportunityCompetitorDTO	Opportunity Competitor
OpportunityDTO	Opportunity
OpportunityPartnerDTO	Opportunity Partner
OpportunityProductDTO	Opportunity Product
OpportunityReferrerDTO	Opportunity Referrer
OpportunityRefStatusType	Opportunity Ref Status Type
OpportunityStatus	Opportunity Status
PhoneNormalizedDTO	Phone Normalized
PhoneNormalizeType	Phone Normalize Type
PrivacyActivityMotivationImplicitConsentDTO	Privacy Activity Motivation Implicit Consent
PrivacyManagementDTO	Privacy Management
PrivacyTypeManagementDTO	Privacy Type Management
SampleGenerationStrategy	Sample Generation Strategy
SharePermissionDTO	Share Permission
SharingDTO	Sharing
StorageDTO	Storage
StoragePermission	Storage Permission
SyncPropertyFlag	Sync Property Flag
TargetListCrossType	Target List Cross Type
ToDoStates	To Do States
TypePrivacy	Type Privacy

APIv1EnglishLead

Lead

Security

Note

Aliases

Authentication

JWT Token

Bearer Authentication

Identification of the calling application

Actions & Paths

GET: /api/v1/Lead/

Routing template:

Produces:

Response: 200 (Success) ApiActionResult

Samples

Try this !

DELETE: /api/v1/Lead/{id}

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

GET: /api/v1/Lead/{id}

Parameters:

Produces:

Response: 200 (Success) LeadDTO

Samples

Try this !

GET: /api/v1/Lead/{id}/Activities

Parameters:

Produces:

Response: 200 (Success) ActivityDTO

Samples

Try this !

GET: /api/v1/Lead/{id}/Activities/Count

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Try this !

GET: /api/v1/Lead/{id}/ActivitiesIds

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Try this !

GET: /api/v1/Lead/{id}/Archive

Parameters:

Produces:

Response: 400 (Bad Request) integer

Samples

Try this !

GET: /api/v1/Lead/{id}/Convert

Parameters:

Produces:

Response: 400 (Bad Request) array of BusinessObjectTypeInt64KeyValuePair

Samples

Try this !

POST: /api/v1/Lead/{id}/Convert

Parameters:

Produces:

Response: 400 (Bad Request) array of BusinessObjectTypeInt64KeyValuePair

Samples

Try this !

GET: /api/v1/Lead/{id}/ConvertToCompany

Parameters:

Produces:

Response: 400 (Bad Request) array of BusinessObjectTypeInt64KeyValuePair

Samples

Try this !

POST: /api/v1/Lead/{id}/ConvertToCompany

Parameters:

Produces:

Response: 400 (Bad Request) array of BusinessObjectTypeInt64KeyValuePair

Samples

Try this !

GET: /api/v1/Lead/{id}/ConvertToCompanyNaturalPerson

Parameters:

Produces:

Response: 400 (Bad Request) array of BusinessObjectTypeInt64KeyValuePair

API v1 English Lead