Skip to content

Update account notes

POST
/api/connector/v1/accountNotes/update

Updates information about the specified account notes.

MultipleAccountNoteUpdateParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
ChainId

Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.

string format: uuid
nullable
AccountNoteUpdates
required

Account notes to be updated.

Array<object>
>= 1 items <= 1000 items
Account note update parameters
object
AccountNoteId
required

Unique identifier of the account note.

string format: uuid
Content
String update value

Content of the account note (or null if the content should not be updated).

object
Value

Value which is to be updated.

string
nullable
Classifications
required
Account note update classifications

Classification of the account note.

object
General
Boolean update value

Company and Customer: Boolean value defining the general classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
FoodAndBeverage
Boolean update value

Customer only: Boolean value defining the food and beverage classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
FrontOffice
Boolean update value

Customer only: Boolean value defining the front office classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
Reservations
Boolean update value

Customer only: Boolean value defining the reservations classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
Housekeeping
Boolean update value

Customer only: Boolean value defining the housekeeping classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
Maintenance
Boolean update value

Customer only: Boolean value defining the maintenance classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
PreviousStay
Boolean update value

Customer only: Boolean value defining the previous stay classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
FamilyRelations
Boolean update value

Customer only: Boolean value defining the family relations classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
Gifts
Boolean update value

Customer only: Boolean value defining the gifts classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
Accounting
Boolean update value

Customer only: Boolean value defining the accounting classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
Complaints
Boolean update value

Customer only: Boolean value defining the complaints classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
Other
Boolean update value

Customer only: Boolean value defining the other classification for the account note (or null if the value should not be updated).

object
Value

Value which is to be updated.

boolean
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"AccountNoteUpdates": [
{
"AccountNoteId": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
"Content": {
"Value": "The AC in the room doesn't work anymore"
},
"Classifications": {
"Maintenance": {
"Value": true
},
"Housekeeping": {
"Value": false
}
}
}
]
}

OK

AccountNoteUpdateResult
object
AccountNotes
required

Updated account notes.

Array<object>
Account note
object
Id
required

Unique identifier of the account note.

string format: uuid
AccountId
required

Unique identifier of the account.

string format: uuid
Content
required

The content of the account note.

string
>= 1 characters
AccountType
required
Account type

Specifying type of associated account.

Company

Customer

string
Allowed values: Company Customer
Classifications
required

Specifying the classifications of the note based on account type.

Array<string>
Allowed values: General FoodAndBeverage FrontOffice Reservations Housekeeping Maintenance PreviousStay FamilyRelations Gifts Accounting Complaints Other
IsActive
required

Whether the account note is still active.

boolean
CreatorProfile
required
Profile data

The profile data of the user who created the account note.

object
Discriminator
required
Profile data discriminator
string
Allowed values: Personal Enterprise Platform Static Integration
EnterpriseProfile
Enterprise profile data

Enterprise profile data.

object
ProfileId
required

Unique identifier of the profile.

string format: uuid
UpdaterProfile
required
Profile data

The profile data of the user who updated the account note.

object
Discriminator
required
Profile data discriminator
string
Allowed values: Personal Enterprise Platform Static Integration
EnterpriseProfile
Enterprise profile data

Enterprise profile data.

object
ProfileId
required

Unique identifier of the profile.

string format: uuid
Example
{
"AccountNotes": [
{
"Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
"AccountId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
"Content": "The AC in the room doesn't work anymore",
"AccountType": "Customer",
"Classifications": [
"Maintenance"
],
"IsActive": true,
"CreatorProfile": {
"Discriminator": "Enterprise",
"EnterpriseProfile": {
"ProfileId": "52d19c34-b0aa-4635-905d-1326fa8b8e13"
}
},
"UpdaterProfile": {
"Discriminator": "Integration",
"EnterpriseProfile": null
}
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable