The opportunitytype object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this opportunitytype |
BusinessId: Id required |
Name: string required |
NotesTemplate: string optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this opportunitytype |
SystemId: string optional api-only
User defined data about this opportunitytype. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BusinessId": 12345678,
"Name": "Name",
"NotesTemplate": "Notes Template",
"UniqueId": "bf69fe19-d226-4c14-bd63-96651e17af39",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a OpportunityType
This endpoint allows you to GET a list of opportunitytypes based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/crm/opportunitytypes?...
π Requires role "OpportunityType-List"
Pagination querystring parameters
Lets control how many records to return at a time and their order. |
page integer optional
?page=1 |
size integer optional default=25
Sets the maximum number of records to return each page of results. ?size=25 |
orderby string optional default=Id
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search opportunitytype records based on their different properties. |
Id number
?Id=12345678 |
OpportunityType_Business Business
?OpportunityType_Business=... |
OpportunityType_Name string
?OpportunityType_Name=... |
OpportunityType_NotesTemplate string
?OpportunityType_NotesTemplate=... |
Range search querystring parameters
Lets you search opportunitytype records based on a range of date or numeric values. |
To_OpportunityType_CreatedOn date
?To_OpportunityType_CreatedOn=2010-01-01T20:32 |
From_OpportunityType_CreatedOn date
?From_OpportunityType_CreatedOn=2010-01-01T20:32 |
To_OpportunityType_UpdatedOn date
?To_OpportunityType_UpdatedOn=2010-01-01T20:32 |
From_OpportunityType_UpdatedOn date
?From_OpportunityType_UpdatedOn=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/crm/opportunitytypes?OpportunityType_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Name",
"NotesTemplate": "Notes Template",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "021e7f1a-68c3-4f91-a4ed-cc5d58bfa46b",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 25,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 60,
"TotalPages": 3
}
Find OpportunityTypes by IDs
Gets one or more opportunitytype records based on their Id.GET https://spaces.nexudus.com/api/crm/opportunitytypes?OpportunityType_Id=[:id1,:id2,...]
π Requires role "OpportunityType-List"
Querystring parameters |
OpportunityType_Id: array requried
?OpportunityType_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/crm/opportunitytypes?OpportunityType_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Name",
"NotesTemplate": "Notes Template",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "a09c2ea4-6fbc-49d4-8b29-03866441e7e2",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single OpportunityType by Id
Gets one opportunitytype record by its Id.GET https://spaces.nexudus.com/api/crm/opportunitytypes/:Id
π Requires role "OpportunityType-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/crm/opportunitytypes/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BusinessId": 12345678,
"Name": "Name",
"NotesTemplate": "Notes Template",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "4a765fd6-2c0d-414c-b799-5b26dce0f3f7",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new OpportunityType
Creates a new opportunitytype.POST https://spaces.nexudus.com/api/crm/opportunitytypes
π Requires role "OpportunityType-Create"
Body parameters |
BusinessId: number required |
Name: string required |
NotesTemplate: string optional |
Example request
POST https://spaces.nexudus.com/api/crm/opportunitytypes Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"Name": "Name",
"NotesTemplate": "Notes Template",
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully created.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Update OpportunityType
Updates an existing opportunitytype.PUT https://spaces.nexudus.com/api/crm/opportunitytypes
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "OpportunityType-Edit"
Body parameters |
Id: number required
The unique Id of the opportunitytype to update. |
BusinessId: number cleared if missing |
Name: string cleared if missing |
NotesTemplate: string cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/crm/opportunitytypes Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"Name": "Name",
"NotesTemplate": "Notes Template",
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully updated.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Delete OpportunityType
Deletes an existing opportunitytype by its Id.DELETE https://spaces.nexudus.com/api/crm/opportunitytypes/:Id
π Requires role "OpportunityType-Delete"
URL parameters |
Id: number required
The unique Id of the opportunitytype to update. |
Example request
DELETE https://spaces.nexudus.com/api/crm/opportunitytypes/12345678 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "The record was deleted successfully.",
"Value": null,
"OpenInDialog": false,
"RedirectURL": null,
"JavaScript": null,
"Errors": null
}
Commands
Commands allow to perform actions against one or more opportunitytype records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.Get Commands
Get all commands available to run for opportunitytype records.GET https://spaces.nexudus.com/api/crm/opportunitytypes/commands
Example request
GET https://spaces.nexudus.com/api/crm/opportunitytypes/commands Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
[
{
"Key": "COMMAND_KEY_1",
"Name": "Command 1 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": false,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": false,
"NeedsEntitiesToRun": true,
"Order": 2,
"RequiresParameters": []
},
{
"Key": "COMMAND_KEY_2",
"Name": "Command 2 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": true,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": true,
"NeedsEntitiesToRun": true,
"Order": 10,
"RequiresParameters":
[
{
"Name": "Parameter 1 description",
"Type": "string",
},
{
"Name": "Parameter 2 description",
"Type": "Boolean",
}
]
},
...
]
Run Command
Runs a command based on its Key and one or more opportunitytype record IDs.POST https://spaces.nexudus.com/api/crm/opportunitytypes/runacommandπ Requires role "OpportunityType-Edit"
Example request
POST https://spaces.nexudus.com/api/crm/opportunitytypes/runcommand Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Ids":[1329961649],
"Parameters":
[
{
"Type": "string"
"Value":987654321
},
{
"Type": "Boolean",
"Value":true
},
...
],
"Key":"COMMAND_KEY_2"
}
Example valid response
{
"Errors": null
"JavaScript": null
"Message": "Result description"
"OpenInDialog": false
"OpenInWindow": false
"RedirectURL": null
"Status": 200
"UpdatedBy": "email@example.net"
"UpdatedOn: "2020-06-04T11:40:20Z"
"Value: {Id: 12345678}
"WasSuccessful: true
}
Comments
Please sign in to leave a comment.