update_notification

Partially update a notification; use clear flags for nullable fields.

settings replaces the channel’s settings (see create_notification). Changing channel starts from that channel’s settings, so a change to push needs a path and the mobile_distribution capability.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "application_id": {
      "title": "Application Id",
      "type": "string"
    },
    "body_template": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Body Template"
    },
    "channel": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Channel"
    },
    "clear_description": {
      "default": false,
      "title": "Clear Description",
      "type": "boolean"
    },
    "clear_model_id": {
      "default": false,
      "title": "Clear Model Id",
      "type": "boolean"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "is_active": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Is Active"
    },
    "model_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Model Id"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "notification_id": {
      "title": "Notification Id",
      "type": "string"
    },
    "recipient_config": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Recipient Config"
    },
    "settings": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Settings"
    },
    "subject_template": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Subject Template"
    },
    "trigger_events": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Trigger Events"
    }
  },
  "required": [
    "application_id",
    "notification_id"
  ],
  "title": "update_notificationArguments",
  "type": "object"
}

Output schema

{
  "properties": {
    "applicationId": {
      "format": "uuid",
      "title": "Applicationid",
      "type": "string"
    },
    "bodyTemplate": {
      "title": "Bodytemplate",
      "type": "string"
    },
    "channel": {
      "enum": [
        "email",
        "push"
      ],
      "title": "NotificationChannel",
      "type": "string"
    },
    "createdAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Createdat"
    },
    "createdBy": {
      "format": "uuid",
      "title": "Createdby",
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "isActive": {
      "title": "Isactive",
      "type": "boolean"
    },
    "modelId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Modelid"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "recipientConfig": {
      "additionalProperties": true,
      "title": "Recipientconfig",
      "type": "object"
    },
    "settings": {
      "additionalProperties": true,
      "title": "Settings",
      "type": "object"
    },
    "subjectTemplate": {
      "title": "Subjecttemplate",
      "type": "string"
    },
    "triggerEvents": {
      "items": {
        "type": "string"
      },
      "title": "Triggerevents",
      "type": "array"
    },
    "updatedAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updatedat"
    }
  },
  "required": [
    "id",
    "applicationId",
    "name",
    "channel",
    "subjectTemplate",
    "bodyTemplate",
    "recipientConfig",
    "triggerEvents",
    "isActive",
    "settings",
    "createdBy"
  ],
  "title": "PublicNotificationResponse",
  "type": "object"
}