{ "sections": [ "title", "description", "supported_soap_calls", "supported_rest_api_http_methods", "fields", "wsdl_segment" ], "title": "WorkflowAlert - Tooling API", "description": "Represents a workflow alert. A workflow alert is an email generated by a workflow rule or approval process and sent to designated recipients.", "supported_soap_calls": "`create()`, `delete()`, `query()`, `retrieve()`, `search()`, `update()`, `upsert()`", "supported_rest_api_http_methods": "`DELETE`, `GET`, `PATCH`, `POST`", "fields_columns": [ "type", "properties", "description" ], "fields": { "CcEmails": { "type": "string", "properties": "Filter, Nillable, Sort", "description": "Additional CC email addresses." }, "Description": { "type": "string", "properties": "Filter, Group, idLookup, Sort", "description": "A description of the workflow alert." }, "DeveloperName": { "type": "string", "properties": "Filter, Group, Sort", "description": "The unique name of the workflow alert in the API." }, "EntityDefinition": { "type": "EntityDefinition", "properties": "Filter, Group, Sort.", "description": "Available in version 34.0. The entity definition for the object associated with this WebLink.", "required": true }, "EntityDefinitionId": { "type": "string", "properties": "Filter, Group, Sort", "description": "The ID of the entity containing the alert." }, "FullName": { "type": "string", "properties": "Create, Group, Nillable", "description": "The full name of the associated metadata object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance." }, "ManageableState": { "type": "ManageableState enumerated list", "properties": "Filter, Group, Nillable, Restricted picklist, Sort", "description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged" }, "Metadata": { "type": "mns:WorkflowAlert", "properties": "Create, Nillable, Update", "description": "Alert definition metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance." }, "NamespacePrefix": { "type": "string", "properties": "Filter, Group, Sort", "description": "The namespace of the package to uniquely identify the workflow alert." }, "SenderType": { "type": "ActionEmailSenderType enumerated list", "properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort", "description": "The type of sender. Values are: CurrentUser OrgWideEmailAddress DefaultWorkflowUser" }, "TemplateId": { "type": "ID", "properties": "Filter, Group, Sort", "description": "A reference to an email template." } }, "wsdl_segment": "```xml\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n```" }