v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

ProfileNote

Archive profile note

Archive a note by setting the archived_at timestamp. Archived notes can be restored later.

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

Path parameters

profileIdinteger required

Entity ID

noteIdinteger required

Note ID

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Response

Profile note archived 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"
}