Skip to content
Mews Open API

Add account notes

POST
/api/connector/v1/accountNotes/add

Adds account notes to an account of the enterprise chain. Note this operation supports Portfolio Access Tokens.

Request Body

Section titled “Request Body ”
MultipleAccountNoteAddParameters
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
AccountNotes
required

Account notes to be added.

Array<object>
>= 1 items <= 1000 items
Account note parameters
object
AccountId
required
string format: uuid
Content
required

The content of the account note.

string
>= 1 characters <= 1000 characters
Classifications
required

Specifying the classifications of the note based on account type.

Array<string>
>= 1 items <= 1 items unique items
Allowed values: General FoodAndBeverage FrontOffice Reservations Housekeeping Maintenance PreviousStay FamilyRelations Gifts Accounting Complaints Other
Example
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
  "AccountNotes": [
    {
      "AccountId": "8ddea57b-6a5c-4eec-8c4c-24467dce118e",
      "Content": "Brother of the CEO",
      "Classifications": [
        "FamilyRelations"
      ]
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

AccountNoteAdditionResult
object
AccountNotes
required

Added 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": "Brother of the CEO",
      "AccountType": "Customer",
      "Classifications": [
        "FamilyRelations"
      ],
      "IsActive": true,
      "CreatorProfile": {
        "Discriminator": "Enterprise",
        "EnterpriseProfile": {
          "ProfileId": "52d19c34-b0aa-4635-905d-1326fa8b8e13"
        }
      },
      "UpdaterProfile": {
        "Discriminator": "Integration",
        "EnterpriseProfile": null
      }
    }
  ]
}

204

Section titled “204 ”

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

400

Section titled “400 ”

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

401

Section titled “401 ”

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

403

Section titled “403 ”

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

408

Section titled “408 ”

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

429

Section titled “429 ”

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

500

Section titled “500 ”

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