Messaging API (1.0)
Download OpenAPI specification:Download
If you have any questions, comments or feedback regarding our APIs, please contact developer@ovipro.fi.
Get agency messaging settings
Get messaging and notification settings for the agency office. If no settings for the agency office exists default settings are returned.
Authorizations:
query Parameters
| agencyOfficeId required | string <uuid> (AgencyOfficeId) Example: agencyOfficeId=7bdffe48-0077-4de0-acd4-d9b9b1ab49f8 Unique identifier for the agency office in the UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 404
- 429
- 500
- 503
{- "agencyOfficeId": "123e4567-e89b-12d3-a456-426655440000",
- "messageSettings": {
- "partyCreated": {
- "emailSendingEnabled": true
}, - "meetingConfirmation": {
- "emailSendingEnabled": false
}, - "meetingReminder": {
- "emailSendingEnabled": false
}, - "showingConfirmation": {
- "emailSendingEnabled": true
}, - "showingReminder": {
- "emailSendingEnabled": false
}, - "showingAcknowledgement": {
- "emailSendingEnabled": true
}, - "buyerActivation": {
- "emailSendingEnabled": false
}, - "sellerActivation": {
- "emailSendingEnabled": true
}, - "offerPartyNotification": {
- "emailSendingEnabled": true
}
}
}Save agency messaging settings
Save messaging and notification settings for the agency office
Authorizations:
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request Body schema: application/jsonrequired
Messaging and notification settings for the agency office
| agencyOfficeId required | string <uuid> (AgencyOfficeId) Unique identifier for the agency office in the UUID format. |
required | object (MessageTypeSettings) Settings for different message types |
Responses
Request samples
- Payload
{- "agencyOfficeId": "123e4567-e89b-12d3-a456-426655440000",
- "messageSettings": {
- "partyCreated": {
- "emailSendingEnabled": true
}, - "meetingConfirmation": {
- "emailSendingEnabled": false
}, - "meetingReminder": {
- "emailSendingEnabled": false
}, - "showingConfirmation": {
- "emailSendingEnabled": true
}, - "showingReminder": {
- "emailSendingEnabled": false
}, - "showingAcknowledgement": {
- "emailSendingEnabled": true
}, - "buyerActivation": {
- "emailSendingEnabled": false
}, - "sellerActivation": {
- "emailSendingEnabled": true
}, - "offerPartyNotification": {
- "emailSendingEnabled": true
}
}
}Response samples
- 200
- 400
- 401
- 404
- 429
- 500
- 503
{ }Get agency messaging survey settings
Get messaging survey settings for the agency office. If no settings for the agency office exists default settings are returned.
Authorizations:
query Parameters
| agencyOfficeId required | string <uuid> (AgencyOfficeId) Example: agencyOfficeId=7bdffe48-0077-4de0-acd4-d9b9b1ab49f8 Unique identifier for the agency office in the UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 404
- 429
- 500
- 503
{- "agencyOfficeId": "123e4567-e89b-12d3-a456-426655440000",
- "surveySettings": {
- "requestRealtyInformation": {
- "sid": "2945807010",
- "sh": "CJ2XrWyeFjCzKlvr82nNvYrvrMeujVu-v6j3YTDcYnnggxILSwDHWi5GuJE3wizT"
}, - "requestPriceEstimate": {
- "sid": "2945807921",
- "sh": "CZ2XrRyeFjCzKlvr82aAvYrvrMeujxX-v6j3YTDcYnnggxILSwDHWi5GuJE3fooT"
}, - "requestSalesMaterial": {
- "sid": "2945900029",
- "sh": "CR55rWyeFjCzKlvr82nNvYrvrMeujVu-v6j3YTDcYnnggxILSwDHWi5GuJE3bazT"
}, - "makeOffer": {
- "sid": "2945107771",
- "sh": "CH5XrWyeFjCzKlvr82nNvYrvrMeujVu-v6j3YTDcYnnggxILSwDHWi5GuJE3zzzT"
}, - "leaveFeedback": {
- "sid": "2948108722",
- "sh": "C90XrWyeFjCzKlvr82nNvYrvrMeujVu-v6j3YTDcYnnggxILSwDHei5GuJE3wazT"
}
}
}Save agency messaging survey settings
Save messaging survey settings for the agency office
Authorizations:
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request Body schema: application/jsonrequired
Messaging survey settings for the agency office
| agencyOfficeId required | string <uuid> (AgencyOfficeId) Unique identifier for the agency office in the UUID format. |
required | object (SurveyTypeSettings) Settings for different survey types |
Responses
Request samples
- Payload
{- "agencyOfficeId": "123e4567-e89b-12d3-a456-426655440000",
- "surveySettings": {
- "requestRealtyInformation": {
- "sid": "2945807010",
- "sh": "CJ2XrWyeFjCzKlvr82nNvYrvrMeujVu-v6j3YTDcYnnggxILSwDHWi5GuJE3wizT"
}, - "requestPriceEstimate": {
- "sid": "2945807921",
- "sh": "CZ2XrRyeFjCzKlvr82aAvYrvrMeujxX-v6j3YTDcYnnggxILSwDHWi5GuJE3fooT"
}, - "requestSalesMaterial": {
- "sid": "2945900029",
- "sh": "CR55rWyeFjCzKlvr82nNvYrvrMeujVu-v6j3YTDcYnnggxILSwDHWi5GuJE3bazT"
}, - "makeOffer": {
- "sid": "2945107771",
- "sh": "CH5XrWyeFjCzKlvr82nNvYrvrMeujVu-v6j3YTDcYnnggxILSwDHWi5GuJE3zzzT"
}, - "leaveFeedback": {
- "sid": "2948108722",
- "sh": "C90XrWyeFjCzKlvr82nNvYrvrMeujVu-v6j3YTDcYnnggxILSwDHei5GuJE3wazT"
}
}
}Response samples
- 200
- 400
- 401
- 404
- 429
- 500
- 503
{ }Get party messaging settings
Get messaging and notification settings for the party. If no settings for the party exists default settings are returned.
Authorizations:
query Parameters
| partyId required | string <uuid> (PartyId) Example: partyId=6d8fcc0d-4a1c-4d7c-84f8-5dd871c12a33 Unique identifier for the party in the UUID format. |
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Responses
Response samples
- 200
- 400
- 401
- 404
- 429
- 500
- 503
{- "partyId": "6d8fcc0d-4a1c-4d7c-84f8-5dd871c12a33",
- "isEmailSendingEnabled": true
}Save party messaging settings
Save messaging and notification settings for the party
Authorizations:
header Parameters
| Request-ID required | string <uuid> Example: 9031d1c5-7d40-41dd-b2b8-7919a2fc4fe9 A unique id which identifies the HTTP request. The value of this header must be created by the client. This identifier is used for troubleshooting purposes. |
Request Body schema: application/jsonrequired
Messaging and notification settings for the party
| partyId required | string <uuid> (PartyId) Unique identifier for the party in the UUID format. |
| isEmailSendingEnabled required | boolean Indicates whether email sending is enabled or disabled for this party. |
Responses
Request samples
- Payload
{- "partyId": "6d8fcc0d-4a1c-4d7c-84f8-5dd871c12a33",
- "isEmailSendingEnabled": true
}Response samples
- 200
- 400
- 401
- 404
- 429
- 500
- 503
{ }