Update an event

Updated:

PUT/messaging/{connection_id}/event/{id}

Updates the MessagingEvent identified by id. Provide the unified MessagingEvent fields to change in the request body.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Event

Payload

idstring
not used
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
type enum
Valid values:
"MESSAGE_RECEIVED"
"REACTION_ADDED"
"REACTION_REMOVED"
"BUTTON_CLICK"
"APP_MENTION"
channelobject
messageobject
buttonobject
userobject
metadata array
is_replacing_originalboolean

Returns

Response fieldTypeRequiredDescription
idstringNonot used
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
typeenumNoValues: MESSAGE_RECEIVED, REACTION_ADDED, REACTION_REMOVED, BUTTON_CLICK, APP_MENTION, CHANNEL_JOINED, CHANNEL_LEFT, CHANNEL_CREATED, CHANNEL_DELETED, CHANNEL_RENAMED, USER_CREATED, USER_DELETED, USER_UPDATED
channelobjectNo
channel.idstringNo
channel.created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
channel.updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
channel.namestringNo
channel.descriptionstringNo
channel.parent_idstringNo
channel.has_subchannelsbooleanNo
channel.membersMessagingMember[]No
channel.members[].user_idstringNo(reference to HrisEmployee)
channel.members[].emailstringNo
channel.members[].namestringNo
channel.members[].image_urlstringNo
channel.is_activebooleanNo
channel.is_privatebooleanNo
channel.web_urlstringNo
channel.metadataMessagingMetadata[]No
channel.metadata[].idstringNo
channel.metadata[].slugstringNo
channel.metadata[].valueobjectNo
channel.metadata[].namespacestringNo
channel.metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
channel.metadata[].extra_dataobjectNo
messageobjectNo
message.idstringNo
message.created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
message.updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
message.channelsMessagingReference[]NoRepresents all channels to which the message is sent. Identifies the channels where the message is posted. To send to the "Draft" channel/folder, use a channel ID "DRAFT".
message.channels[].idstringNo
message.channels[].namestringNo
message.parent_idstringNoRepresents the ID of the immediate predecessor message in the thread. Identifies a specific message to which the current message directly replies.
message.message_thread_identifierstringNothe opaque identifier for the first message in a thread
message.author_memberMessagingEvent_message_author_memberNofor email systems, this field represents the From value
message.author_member.user_idstringNo(reference to HrisEmployee)
message.author_member.emailstringNo
message.author_member.namestringNo
message.author_member.image_urlstringNo
message.destination_membersMessagingMember[]Nofor email systems, this field represents the To value
message.destination_members[].user_idstringNo(reference to HrisEmployee)
message.destination_members[].emailstringNo
message.destination_members[].namestringNo
message.destination_members[].image_urlstringNo
message.hidden_membersMessagingMember[]Nofor email systems, this field represents the BCC value
message.hidden_members[].user_idstringNo(reference to HrisEmployee)
message.hidden_members[].emailstringNo
message.hidden_members[].namestringNo
message.hidden_members[].image_urlstringNo
message.mentioned_membersMessagingMember[]Nofor email systems, this field represents the CC value
message.mentioned_members[].user_idstringNo(reference to HrisEmployee)
message.mentioned_members[].emailstringNo
message.mentioned_members[].namestringNo
message.mentioned_members[].image_urlstringNo
message.reactionsMessagingReaction[]No
message.reactions[].reactionstringYes
message.reactions[].memberMessagingReaction_memberYes
message.reactions[].member.user_idstringNo(reference to HrisEmployee)
message.reactions[].member.emailstringNo
message.reactions[].member.namestringNo
message.reactions[].member.image_urlstringNo
message.subjectstringNo
message.messagestringNoThe message body as plain text
message.message_htmlstringNo
message.message_markdownstringNo
message.attachmentsMessagingAttachment[]No
message.attachments[].filenamestringNo
message.attachments[].sizenumberNo
message.attachments[].content_identifierstringNothe inline attachment's content_id
message.attachments[].content_typestringNo
message.attachments[].download_urlstringNo
message.attachments[].message_idstringNo
message.web_urlstringNo
message.referencestringNoeg. RFC822 MessageID
message.has_childrenbooleanNo
message.is_unreadbooleanNo
message.buttonsMessagingButton[]No
message.buttons[].idstringYes
message.buttons[].textstringNo
message.buttons[].iconstringNo
message.metadataMessagingMetadata[]No
message.metadata[].idstringNo
message.metadata[].slugstringNo
message.metadata[].valueobjectNo
message.metadata[].namespacestringNo
message.metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
message.metadata[].extra_dataobjectNo
buttonobjectNo
button.idstringYes
button.textstringNo
button.iconstringNo
userobjectNo
user.idstringNo
user.namestringNo
metadataMessagingMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
is_replacing_originalbooleanNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'PUT',
  url: 'https://api.unified.to/messaging/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?