v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

ProfileNote

Add note to a profile

Create a new note for a profile (group, company, or travel agent)

post/group-profile/v1/profiles/{profileId}/notes

Path parameters

profileIdinteger required

Entity ID

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Request body

userIdinteger required

User ID of the person who created the note

contentstring required

Content of the note

Example request

{
  "userId": 12345,
  "content": "Customer requested late checkout due to flight delay"
}

Response

Note added successfully

idstring required

Unique identifier for the profile note

profileIdstring required

ID of the profile (group, company, or travel agent)

contentstring

Content of the note

archivedAtstring date-time

Timestamp when the note was archived (null if not archived)

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

Example response

{
  "id": "12345",
  "profileId": "67890",
  "user": {
    "id": "12345",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  },
  "content": "Customer requested late checkout due to flight delay"
}