Skip to main content

​
Announcements (Comunicados)

Announcements are official communications sent to community residents. They include a title, subtitle, content, and optional image.

​
Get All Announcements

GET /api/comunicados
Returns all announcements in the system. Authorization: Required (ADMIN_COMPANY, SYSTEM_ADMIN) Response: 
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "communityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "communityName": "Example Community",
    "titulo": "Important Notice",
    "subtitulo": "Please read carefully",
    "contenido": "This is the full content of the announcement...",
    "fecha": "2026-03-04T10:00:00Z",
    "imagen": "https://example.com/image.jpg",
    "createdAt": "2026-03-01T08:30:00Z"
  }
]

​
Get Paginated Announcements

GET /api/comunicados/paginated?page=1&pageSize=20
Returns announcements with pagination. Default: first 20 announcements, most recent first. Authorization: Required (ADMIN_COMPANY, SYSTEM_ADMIN) Query Parameters:
  • page (integer, optional): Page number, default: 1
  • pageSize (integer, optional): Items per page, default: 20
Response: Same structure as Get All Announcements

​
Get Announcements by Community

GET /api/comunicados/community/{communityId}
Returns all announcements for a specific community. Authorization: Required (ADMIN_COMPANY, SYSTEM_ADMIN) Path Parameters:
  • communityId (guid, optional): Community ID. If null, returns announcements not associated with any specific community.
Response: Same structure as Get All Announcements

​
Get Announcement by ID

GET /api/comunicados/{id}
Returns a specific announcement by ID. Authorization: Required (ADMIN_COMPANY, SYSTEM_ADMIN) Path Parameters:
  • id (guid, required): Announcement ID
Response: 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communityName": "Example Community",
  "titulo": "Important Notice",
  "subtitulo": "Please read carefully",
  "contenido": "This is the full content of the announcement...",
  "fecha": "2026-03-04T10:00:00Z",
  "imagen": "https://example.com/image.jpg",
  "createdAt": "2026-03-01T08:30:00Z"
}
Error Responses:
  • 404 Not Found: Announcement not found

​
Create Announcement

POST /api/comunicados
Creates a new announcement. Authorization: Required (ADMIN_COMPANY, SYSTEM_ADMIN) Request Body: 
{
  "communityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "titulo": "Important Notice",
  "subtitulo": "Please read carefully",
  "contenido": "This is the full content of the announcement...",
  "fecha": "2026-03-04T10:00:00Z",
  "imagen": "https://example.com/image.jpg"
}
Field Validations:
  • titulo (string, required): Maximum 200 characters
  • subtitulo (string, optional): Maximum 300 characters
  • contenido (string, required): Maximum 4000 characters
  • fecha (datetime, required): Date of the announcement
  • imagen (string, optional): Maximum 500 characters
  • communityId (guid, optional): Community ID
Response: 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "communityName": "Example Community",
  "titulo": "Important Notice",
  "subtitulo": "Please read carefully",
  "contenido": "This is the full content of the announcement...",
  "fecha": "2026-03-04T10:00:00Z",
  "imagen": "https://example.com/image.jpg",
  "createdAt": "2026-03-01T08:30:00Z"
}
Status Code: 201 Created Error Responses:
  • 400 Bad Request: Invalid data or validation error

​
Update Announcement

PUT /api/comunicados/{id}
Updates an existing announcement. Authorization: Required (ADMIN_COMPANY, SYSTEM_ADMIN) Path Parameters:
  • id (guid, required): Announcement ID
Request Body: 
{
  "communityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "titulo": "Updated Notice",
  "subtitulo": "Updated subtitle",
  "contenido": "Updated content...",
  "fecha": "2026-03-04T10:00:00Z",
  "imagen": "https://example.com/updated-image.jpg"
}
Field Validations: Same as Create Announcement Response: Same structure as Get Announcement by ID Error Responses:
  • 404 Not Found: Announcement not found
  • 400 Bad Request: Invalid data or validation error

​
Delete Announcement

DELETE /api/comunicados/{id}
Deletes an announcement. Authorization: Required (ADMIN_COMPANY, SYSTEM_ADMIN) Path Parameters:
  • id (guid, required): Announcement ID
Response: No content Status Code: 204 No Content Error Responses:
  • 404 Not Found: Announcement not found

​
Announcement Object Schema

FieldTypeDescription
idguidUnique identifier for the announcement
communityIdguidCommunity ID (optional)
communityNamestringName of the community (populated from community data)
titulostringAnnouncement title (max 200 characters)
subtitulostringAnnouncement subtitle (max 300 characters)
contenidostringFull content of the announcement (max 4000 characters)
fechadatetimeDate of the announcement
imagenstringImage URL (optional, max 500 characters)
createdAtstringISO date string for when the announcement was created

Build docs developers (and LLMs) love

Get started for freeTalk to us