POST api/v1/Points
Will create new point for contact with specified information. Will return HTTP 404 if contact with given Id is not found.
Request Information
URI Parameters
None.
Body Parameters
CreatePointDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ContactId |
Id of contact |
integer |
Required |
| ContactCompanyId |
Id of ContactCompany. Applies only if the contact is associated with a company. |
integer |
None. |
| Type |
Type of point |
string |
Required Max length: 32 |
| Amount |
Amount of point |
decimal number |
Required |
| Description |
Description of point |
string |
Required |
| SourceId |
Id of source for the point |
string |
Max length: 255 |
| SourceDescription |
Description of source |
string |
None. |
| StoreId |
Id of store for the point |
integer |
None. |
| BookValue |
Value of the point for bookkeeping |
decimal number |
None. |
| SubType |
SubType of point |
string |
Max length: 32 |
| PointCalculationBase |
The original value the point value was calculated from |
decimal number |
None. |
| Dynamic_ |
[WARNING] This property represent the prefix for dynamic point properties. If the exchange rate has a value of 'Test' on its property {Amount2PointMember}, then use 'Dynamic_Test' to save a value on the point |
string |
None. |
Request Formats
application/json, text/json
{
"ContactId": 1,
"ContactCompanyId": 1,
"Type": "sample string 2",
"Amount": 3.0,
"Description": "sample string 4",
"SourceId": "sample string 5",
"SourceDescription": "sample string 6",
"StoreId": 1,
"BookValue": 1.0,
"SubType": "sample string 7",
"PointCalculationBase": 1.0,
"Dynamic_": "sample string 8"
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ReadPointDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Unique id of the point |
integer |
None. |
| ContactId |
Id of contact |
integer |
None. |
| ContactCompanyId |
Id of ContactCompany. Applies only if the contact is associated with a company. |
integer |
None. |
| Type |
Type of point |
string |
Max length: 32 |
| Amount |
Amount of point |
decimal number |
None. |
| Sum |
The sum of all the points with the same contact id and type when the point was created |
decimal number |
None. |
| DateTime |
Creation datetime of the point |
date |
None. |
| Description |
Description of point |
string |
None. |
| SourceId |
Id of source |
string |
Max length: 255 |
| SourceDescription |
Description of source |
string |
None. |
| StoreId |
Id of store for the point |
integer |
None. |
| AdministratorId |
Id of administrator who created the point |
integer |
None. |
| BookValue |
Value of the point for bookkeeping |
decimal number |
None. |
| SubType |
SubType of point |
string |
Max length: 32 |
| PointCalculationBase |
The original value the point value was calculated from |
decimal number |
None. |
| ConverterTransactionId |
The transaction id of a converter |
integer |
None. |
| IsCanceller |
Idicates if this point is a canceller point |
boolean |
None. |
| CancellerPointId |
An id of the point that cancelled this point |
integer |
None. |
Response Formats
application/json, text/json
{
"Id": 1,
"ContactId": 1,
"ContactCompanyId": 1,
"Type": "sample string 2",
"Amount": 3.0,
"Sum": 4.0,
"DateTime": "2025-11-07T10:38:43.6852849+01:00",
"Description": "sample string 6",
"SourceId": "sample string 7",
"SourceDescription": "sample string 8",
"StoreId": 1,
"AdministratorId": 1,
"BookValue": 1.0,
"SubType": "sample string 9",
"PointCalculationBase": 1.0,
"ConverterTransactionId": 1,
"IsCanceller": true,
"CancellerPointId": 1
}