# Get MessageAutomation Get a MessageAutomation by id Endpoint: GET /messageAutomation/{id} Version: 0.9.74 Security: bearer, apiKey, apiSecret ## Header parameters: - `Authorization` (string, required) ## Path parameters: - `id` (string, required) ## Response 200 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `messageAutomation` (object) - `messageAutomation.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `messageAutomation.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `messageAutomation.uuid` (string, required) - `messageAutomation.primaryPlatformId` (string, required) - `messageAutomation.createdAt` (string) The date and time this Entity has been created - `messageAutomation.updatedAt` (string) The date and time this Entity has been updated - `messageAutomation.language` (object) circular reference - `messageAutomation.type` (string) Enum: "messageAutomation", "questionAnswerAutomation", "fileRequestAutomation" - `messageAutomation.name` (string, required) The name of a messageAutomation - `messageAutomation.description` (string, required) The description of a messageAutomation - `messageAutomation.automationConfig` (object) - `messageAutomation.automationConfig.triggerType` (string) Enum: "trigger", "scheduler", "listener" - `messageAutomation.automationConfig.triggerEvent` (string) Enum: "afterCreatingTrip", "afterUpdatingTrip", "afterConfirmingTrip", "afterStartingTrip", "afterFinishingTrip", "afterCancelingTrip", "afterLocationUpdateEvent", "afterCreatingMessage", "afterUpdatingMessage", "afterCreatingEvent", "afterStartEngineEvent", "afterStartMovingEvent", "afterStopMovingEvent", "afterStopEngineEvent", "afterCreatingWaitAction", "afterUpdatingWaitAction", "afterCreatingWeighingAction", "afterUpdatingWeighingAction", "afterCreatingUnloadAction", "afterUpdatingUnloadAction", "afterCreatingStopAction", "afterUpdatingStopAction", "afterCreatingMoveAction", "afterUpdatingMoveAction", "afterCreatingLoadAction", "afterUpdatingLoadAction", "afterCreatingDetachTransportEquipmentAction", "afterUpdatingDetachTransportEquipmentAction", "afterCreatingDetachChauffeurAction", "afterUpdatingDetachChauffeurAction", "afterCreatingBreakAction", "afterUpdatingBreakAction", "afterCreatingAttachTransportEquipmentAction", "afterUpdatingAttachTransportEquipmentAction", "afterCreatingAttachChauffeurAction", "afterUpdatingAttachChauffeurAction", "afterActionLifeCycleUpdate", "afterCreatingCapacityContract", "afterUpdatingCapacityContract", "afterCreatingMessageAutomation", "AfterUpdatingMessageAutomation", "afterCreatingTransportOrder", "afterUpdatingTransportOrder", "afterCreatingConsignment", "afterUpdatingConsignment", "afterCreatingBusiness", "afterUpdatingBusiness", "afterCreatingInvoice", "afterSendingInvoice", "afterUpdatingInvoice", "afterCreatingQuote", "afterUpdatingQuote", "afterSendingQuote", "afterCreatingUser", "afterUpdatingUser", "afterCreatingLocation", "afterUpdatingLocation", "afterExceedingStopAverageDuration", "afterHomeBaseReturnOverdue", "afterCreatingBooking", "afterUpdatingBooking", "afterCancellingBooking", "afterConfirmingBooking", "afterCreatingIntegration", "afterUpdatingIntegration", "afterUpdatingCalendarEvent", "afterDeletingCalendarEvent", "afterCreatingTodo", "afterUpdatingTodo", "afterDeletingTodo", "afterAssigningTodo", "afterCalendarSyncRequested", "afterCalendarAuthorizationGranted" - `messageAutomation.automationConfig.schedule` (object) - `messageAutomation.automationConfig.schedule.integrationSchedulerScheduleValue` (integer) - `messageAutomation.automationConfig.schedule.integrationSchedulerScheduleType` (string) Enum: "seconds", "minutes", "hours", "days", "months" - `messageAutomation.automationConfig.schedule.milliseconds` (integer) - `messageAutomation.automationConfig.uniqueIdentifierSelector` (string) - `messageAutomation.automationConfig.uniqueIdentifierSchedule` (object) - `messageAutomation.automationConfig.filters` (array) - `messageAutomation.automationConfig.filters.selector` (string) - `messageAutomation.automationConfig.filters.comparisonType` (string) Enum: "equal", "not_equal", "greater_than", "greater_or_equal_than", "lesser_than", "lesser_or_equal_than", "between", "in", "not_in", "contains", "starts_with", "ends_with", "is_blank", "is_not_blank" - `messageAutomation.automationConfig.filters.value` (string) - `messageAutomation.automationConfig.filters.linkType` (string) Enum: "and", "or" - `messageAutomation.automationConfig.filters.filters` (array) - `messageAutomation.automationConfig.filters.sequenceNr` (integer) - `messageAutomation.automationConfig.filters.valueSelector` (string) - `messageAutomation.automationConfig.query` (object) - `messageAutomation.automationConfig.query.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `messageAutomation.automationConfig.query.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `messageAutomation.automationConfig.query.createdAt` (string) The date and time this Entity has been created - `messageAutomation.automationConfig.query.updatedAt` (string) The date and time this Entity has been updated - `messageAutomation.automationConfig.query.fields` (array) - `messageAutomation.automationConfig.query.fields.name` (string) - `messageAutomation.automationConfig.query.fields.groupByAggregate` (string) Enum: "count", "max", "min", "sum", "avg" - `messageAutomation.automationConfig.query.entityType` (string) Enum: "action", "attachTransportEquipmentAction", "detachTransportEquipmentAction", "stopAction", "loadAction", "unloadAction", "waitAction", "consignment", "extendedConsignment", "transportEquipment", "extendedTransportEquipment", "items", "goods", "constraint", "actor", "location", "route", "sensor", "vehicle", "extendedVehicle", "trip", "fleet", "transportOrder", "extendedTransportOrder", "business", "event", "locationUpdateEvent", "startMovingEvent", "startWaitingEvent", "stopEngineEvent", "stopMovingEvent", "message", "document", "chauffeur", "extendedChauffeur", "chauffeurTimeslot", "chat", "user", "administration", "fleetVehicle", "messageAutomation", "capacity_contract", "booking", "invoice", "invoice_line", "quote", "quote_line", "integration", "calendarEvent", "to_do" - `messageAutomation.automationConfig.query.joins` (array) - `messageAutomation.automationConfig.query.joins.type` (string) Enum: "inner_join" - `messageAutomation.automationConfig.query.joins.entityType` (string) Enum: "action", "attachTransportEquipmentAction", "detachTransportEquipmentAction", "stopAction", "loadAction", "unloadAction", "waitAction", "consignment", "extendedConsignment", "transportEquipment", "extendedTransportEquipment", "items", "goods", "constraint", "actor", "location", "route", "sensor", "vehicle", "extendedVehicle", "trip", "fleet", "transportOrder", "extendedTransportOrder", "business", "event", "locationUpdateEvent", "startMovingEvent", "startWaitingEvent", "stopEngineEvent", "stopMovingEvent", "message", "document", "chauffeur", "extendedChauffeur", "chauffeurTimeslot", "chat", "user", "administration", "fleetVehicle", "messageAutomation", "capacity_contract", "booking", "invoice", "invoice_line", "quote", "quote_line", "integration", "calendarEvent", "to_do" - `messageAutomation.automationConfig.query.joins.onLeft` (object) - `messageAutomation.automationConfig.query.joins.onRight` (object) - `messageAutomation.automationConfig.query.filters` (array) - `messageAutomation.automationConfig.query.filters.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `messageAutomation.automationConfig.query.filters.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `messageAutomation.automationConfig.query.filters.createdAt` (string) The date and time this Entity has been created - `messageAutomation.automationConfig.query.filters.updatedAt` (string) The date and time this Entity has been updated - `messageAutomation.automationConfig.query.filters.sequenceNr` (integer) - `messageAutomation.automationConfig.query.filters.field` (string) - `messageAutomation.automationConfig.query.filters.comparisonOperations` (string) Enum: "equal", "not_equal", "greater_than", "greater_or_equal_than", "lesser_than", "lesser_or_equal_than", "between", "in", "not_in", "contains", "starts_with", "ends_with", "is_blank", "is_not_blank" - `messageAutomation.automationConfig.query.filters.value` (string) - `messageAutomation.automationConfig.query.filters.valueType` (string) Enum: "constant", "string", "integer", "float", "datetime", "duration", "date", "time", "boolean", "object", "array", "filters", "table" - `messageAutomation.automationConfig.query.filters.linkType` (string) Enum: "and", "or" - `messageAutomation.automationConfig.query.groupBy` (array) - `messageAutomation.automationConfig.query.having` (object) - `messageAutomation.automationConfig.query.sortFields` (array) - `messageAutomation.automationConfig.query.sortDirection` (string) Enum: "asc", "desc" - `messageAutomation.automationConfig.query.limit` (integer) - `messageAutomation.automationConfig.query.offset` (integer) - `messageAutomation.automationConfig.recipients` (array) - `messageAutomation.automationConfig.recipientSelector` (string) - `messageAutomation.automationConfig.toggleForAll` (boolean) - `messageAutomation.automationConfig.channel` (string) Enum: "email", "chat", "notification", "whatsapp", "telegram" - `messageAutomation.automationConfig.manualIntegration` (object) circular reference - `messageAutomation.automationConfig.includeAttachments` (boolean) - `messageAutomation.automationConfig.documentAttachments` (array) - `messageAutomation.automationConfig.documentAttachments.documentSourceType` (string) Enum: "ENTITY_PDF", "CUSTOM_TEMPLATE", "INSIGHT_REPORT", "STATIC_FILE" - `messageAutomation.automationConfig.documentAttachments.documentType` (string) Enum: "cmr", "waybill", "invoice", "quote", "transportOrder", "trip", "custom" - `messageAutomation.automationConfig.documentAttachments.documentTemplateId` (string) - `messageAutomation.automationConfig.documentAttachments.fileUrl` (string) - `messageAutomation.automationConfig.documentAttachments.insightType` (string) - `messageAutomation.automationConfig.documentAttachments.reportParameters` (object) - `messageAutomation.automationConfig.documentAttachments.entityIdSelector` (string) - `messageAutomation.automationConfig.documentAttachments.fileNameTemplate` (string) - `messageAutomation.automationConfig.subject` (string) The subject of a message for a particular messageAutomation - `messageAutomation.automationConfig.currentTriggerPosition` (integer) - `messageAutomation.automationConfig.localizedTexts` (array) - `messageAutomation.automationConfig.localizedTexts.language` (object) - `messageAutomation.automationConfig.localizedTexts.language.id` (string, required) Uniquely identifies this entity. A ID can be assigned or will be generated by the server if the request doesn't provide it. Once assigned, the ID can't be changed - `messageAutomation.automationConfig.localizedTexts.language.nonce` (string) Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created. - `messageAutomation.automationConfig.localizedTexts.language.createdAt` (string) The date and time this Entity has been created - `messageAutomation.automationConfig.localizedTexts.language.updatedAt` (string) The date and time this Entity has been updated - `messageAutomation.automationConfig.localizedTexts.language.name` (string) - `messageAutomation.automationConfig.localizedTexts.language.localName` (string) - `messageAutomation.automationConfig.localizedTexts.language.code` (string) - `messageAutomation.automationConfig.localizedTexts.language.iso3166` (string) - `messageAutomation.automationConfig.localizedTexts.language.decimalDelimiter` (string) - `messageAutomation.automationConfig.localizedTexts.language.thousandDelimiter` (string) - `messageAutomation.automationConfig.localizedTexts.language.dateFormat` (string) - `messageAutomation.automationConfig.localizedTexts.language.measurementUnit` (string) Enum: "metric", "imperial" - `messageAutomation.automationConfig.localizedTexts.content` (string, required) The template of a message for a particular messageAutomation - `messageAutomation.automationConfig.localizedTexts.messageTemplate` (string, required) The template of a message for a particular messageAutomation - `messageAutomation.automationConfig.localizedTexts.subject` (string) - `messageAutomation.automationConfig.defaultLanguageId` (string) - `messageAutomation.automationConfig.languageSelector` (string) - `messageAutomation.automationConfig.userEnableable` (boolean) - `messageAutomation.automationConfig.userPermissionFilters` (array) - `messageAutomation.messageAutomationIntegration` (object) circular reference - `messageAutomation.enabled` (boolean) - `messageAutomation.lastHandled` (string) - `messageAutomation.template` (boolean) - `messageAutomation.templateCategory` (string) ## Response 400 fields (application/json): - `success` (boolean) - `message` (string) - `code` (integer) - `errors` (array) - `suggestion` (string)