Proposal Email Template¶
Proposal Email Template - Update Proposal Email Template¶
HTTP Request
PUT /api/proposal-email-templates/{id}
📋 Description: Updates the specified email template for proposals within the Nakisa Portfolio Management Suite, enabling users to customize communication related to portfolio, asset, and real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated email template data for a specific proposal, including subject, body content, and associated metadata relevant to portfolio and asset management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "label": "string",
10 "cultureId": 0,
11 "proposalEmailId": 0,
12 "labelDtos": [
13 {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "cultureId": 0,
22 "value": "string"
23 }
24 ]
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Proposal Email Template - Delete Proposal Email Template¶
HTTP Request
DELETE /api/proposal-email-templates/{id}
📋 Description: Deletes a specified email template associated with proposals in the Nakisa Portfolio Management Suite, streamlining communication processes within portfolio and asset management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Proposal Email Template - Get Proposal Email Templates¶
HTTP Request
GET /api/proposal-email-templates
📋 Description: Retrieves a list of email templates used for proposals within the Nakisa Portfolio Management Suite, facilitating streamlined communication for portfolio, asset, and real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the proposal email templates should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite for portfolio and asset management. |
|
listing |
query |
boolean |
false |
Indicates whether to include listing details in the proposal email templates retrieved from the Nakisa Portfolio Management Suite, enhancing insights for portfolio and asset management. |
proposal-id |
query |
string |
false |
Unique identifier for the proposal within the Nakisa Portfolio Management Suite, facilitating the retrieval of associated email templates for portfolio, asset, and real estate property analytics. |
proposal-type-id-in |
query |
string |
false |
Unique identifier for the type of proposal, used to filter email templates related to portfolio, asset, analytics, and real estate property within the Nakisa Portfolio Management Suite. |
label-id |
query |
string |
false |
Unique identifier for the email template associated with a proposal, facilitating targeted communication within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "proposalEmailTemplates": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "label": "string",
13 "cultureId": 0,
14 "proposalEmailId": 0,
15 "labelDtos": [
16 {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "cultureId": 0,
25 "value": "string"
26 }
27 ]
28 }
29 ]
30 },
31 "page": {
32 "size": 0,
33 "totalElements": 0,
34 "totalPages": 0,
35 "number": 0
36 }
37}
Proposal Email Template - Create Proposal Email Template¶
HTTP Request
POST /api/proposal-email-templates
📋 Description: Creates a new email template for proposal communications within the Nakisa Portfolio Management Suite, enhancing the efficiency of portfolio and asset management in the real estate sector.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the email template data for portfolio proposals, including subject, body content, and associated metadata for effective communication in asset management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "label": "string",
10 "cultureId": 0,
11 "proposalEmailId": 0,
12 "labelDtos": [
13 {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "cultureId": 0,
22 "value": "string"
23 }
24 ]
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10