communications_messages_banner_partial_update

PATCHhttps://bikanawe.hamwenawe.com/api/v1/communications/messages/{id}/banner/Requires authentication

Show or hide the top site banner for a high/urgent communication.

Parameters

Name	Location	Type	Required	Description
id	path		Yes	A unique integer value identifying this communication.

Request Body

{
  "id": "bbb5787a-958a-4146-91c6-7dd9415942cb",
  "endpoint": "64cf32a4-da6c-4200-a841-15705203097d",
  "content_type": "application/json",
  "documented_json": {
    "type": "announcement",
    "title": "string",
    "status": "draft",
    "message": "string",
    "audience": "all",
    "channels": "string",
    "priority": "low",
    "banner_days": 0,
    "scheduled_at": "2026-01-01T00:00:00Z",
    "banner_hidden": true,
    "exclude_users": "string",
    "specific_users": null
  },
  "last_verified_json": null,
  "is_in_sync": false,
  "last_verified_at": null
}

Sample Responses

{
  "id": 0,
  "type": "announcement",
  "title": "string",
  "status": "draft",
  "message": "string",
  "sent_at": "2026-01-01T00:00:00Z",
  "audience": "all",
  "channels": "string",
  "priority": "low",
  "created_at": "2026-01-01T00:00:00Z",
  "created_by": 0,
  "total_sent": 0,
  "updated_at": "2026-01-01T00:00:00Z",
  "banner_days": 0,
  "banner_live": "string",
  "scheduled_at": "2026-01-01T00:00:00Z",
  "total_failed": 0,
  "banner_hidden": true,
  "exclude_users": "string",
  "banner_ends_at": "2026-01-01T00:00:00Z",
  "specific_users": null,
  "created_by_name": "string",
  "recipient_count": "string",
  "total_recipients": 0,
  "shows_site_banner": "string"
}