Agorapulse · Schema

CreateCalendarNoteOpenRequest

Request to create or update a calendar note

Social Media ManagementSocial MediaCRMAnalyticsPublishingInbox ManagementSocial Listening

Properties

Name Type Description
title string Note title
body string Note body content
color object Note color for calendar display
startDate string Note start date
endDate string Note end date
profileUids array List of profile UIDs associated with the note
View JSON Schema on GitHub

JSON Schema

createcalendarnoteopenrequest.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateCalendarNoteOpenRequest",
  "required": [
    "color",
    "endDate",
    "startDate",
    "title"
  ],
  "type": "object",
  "properties": {
    "title": {
      "minLength": 1,
      "type": "string",
      "description": "Note title",
      "example": "Team Meeting",
      "x-size-message": "Title is required"
    },
    "body": {
      "type": "string",
      "description": "Note body content",
      "example": "Discuss quarterly goals and roadmap"
    },
    "color": {
      "type": "object",
      "description": "Note color for calendar display",
      "allOf": [
        {
          "$ref": "#/components/schemas/PublishingCalendarNoteColor"
        },
        {
          "type": "object"
        }
      ],
      "x-not-null-message": "Color is required"
    },
    "startDate": {
      "type": "string",
      "description": "Note start date",
      "format": "date",
      "example": "2024-01-15T00:00:00.000Z",
      "x-not-null-message": "Start date is required"
    },
    "endDate": {
      "type": "string",
      "description": "Note end date",
      "format": "date",
      "example": "2024-01-15T00:00:00.000Z",
      "x-not-null-message": "End date is required"
    },
    "profileUids": {
      "type": "array",
      "description": "List of profile UIDs associated with the note",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "Request to create or update a calendar note"
}