Create new followups on the specified message.
post
/social/api/v1/messages/{messageID}/followups
Request
Supported Media Types
- application/json
Path Parameters
-
messageID: integer(int64)
The message ID. The object's unique identifier from a long integer representation.
The request body defines the details of the request.
Root Schema : XV1MessageFollowupCreateInfo
Type:
object
V1 Message Followup Create Information.
Show Source
-
assignee(optional):
string
The followup assignee. Required.
-
followupType(optional):
object XV1FollowupType
Nested Schema : XV1FollowupType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "FOR_YOUR_INFORMATION", "PLEASE_REPLY", "PLEASE_REPLY_URGENT" ]
V1 Followup Types.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1MessageFollowupInfo
Type:
object
V1 Message Followup Information DTO.
Show Source
-
altitude(optional):
number(double)
The object's altitude.
-
assigneeDisplayName(optional):
string
The display name of the user this followup is assigned to.
-
assigneeID(optional):
An object's unique identifier from a long integer representation.
-
assigneeName(optional):
string
The name of the user this followup is assigned to.
-
assigneeURL(optional):
string
A URL to the user this followup is assigned to.
-
assignerDisplayName(optional):
string
The display name of the user who assigned this followup.
-
assignerID(optional):
An object's unique identifier from a long integer representation.
-
assignerName(optional):
string
The name of the user who assigned this followup.
-
assignerURL(optional):
string(url)
A URL to the user who assigned this followup.
-
collectionURL(optional):
string(url)
A URL to this object's containing collection.
-
conversationURL(optional):
string(url)
A URL to this object's containing conversation.
-
createdByID(optional):
An object's unique identifier from a long integer representation.
-
createdByURL(optional):
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName(optional):
string
The display name of the user that created this object.
-
createdByUserName(optional):
string
The name of the user that created this object.
-
createdDate(optional):
string(date)
The date this object was created.
-
createdDateInISO8601Format(optional):
string
The date this object was created, in ISO 8601 format.
-
displayName(optional):
string
The display name of this object.
-
followupType(optional):
object XV1FollowupType
-
id(optional):
An object's unique identifier from a long integer representation.
-
isOpen(optional):
boolean
Whether this followup is open or closed.
-
isRead(optional):
boolean
Whether this followup is read.
-
isRemoved(optional):
boolean
True if this message has been removed.
-
isReply(optional):
boolean
Whether this followup has been replied to.
-
latitude(optional):
number(double)
The object's latitude.
-
longitude(optional):
number(double)
The object's longitude.
-
messageURL(optional):
string(url)
A URL to the message this followup is set on.
-
modifiedByID(optional):
An object's unique identifier from a long integer representation.
-
modifiedByURL(optional):
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName(optional):
string
The display name of the user that last modified this object.
-
modifiedByUserName(optional):
string
The name of the user that last modified this object.
-
modifiedDate(optional):
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format(optional):
string
The date this object was last modified, in ISO 8601 format.
-
name(optional):
string
The name of this object.
-
objectType(optional):
string
The type of this object.
-
openDate(optional):
string(date)
When the open/close state last changed.
-
openDateInISO8601Format(optional):
string
When the open/close state last changed, in ISO 8601 format.
-
openURL(optional):
string(url)
A URL to the user who last changed the open/close state.
-
readDate(optional):
string(date)
When the read state last changed.
-
readDateInISO8601Format(optional):
string
When the read state last changed, in ISO 8601 format.
-
removedByID(optional):
An object's unique identifier from a long integer representation.
-
removedByURL(optional):
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName(optional):
string
The display name of the user that last removed this object.
-
removedByUserName(optional):
string
The name of the user that last removed this object.
-
removedDate(optional):
string(date)
The date this object was removed.
-
removedDateInISO8601Format(optional):
string
The date this object was removed, in ISO 8601 format.
-
replyDate(optional):
string(date)
When the last reply happened.
-
replyDateInISO8601Format(optional):
string
When the last reply happened, in ISO 8601 format.
-
replyURL(optional):
string(url)
A URL to any reply message.
-
socialObjectURL(optional):
string(url)
A URL to this object's containing collaboration object.
-
url(optional):
string(url)
A URL to this object.
Nested Schema : XV1FollowupType
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "FOR_YOUR_INFORMATION", "PLEASE_REPLY", "PLEASE_REPLY_URGENT" ]
V1 Followup Types.