Forwards

Create a forward to a Message

post/message-forwards

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/message-forwards
  • Auth: pxtoken (a scheme the document does not define)

Request body

forwarded_message_idstring required

Message ID that will be forwarded

message_idstring nullable

Message ID that will have the forward on it. Only required if visibility is channel.

visibility'channel' | 'public' required

Which is the visibility of forwarded message (channel or public link)

end_access_atstring date-time nullable

Date when the access to forwarded message ends

Response

_idstring required

Unique Identifier of forwarded/shared message

forwarded_bystring required

Identifier of the User who forwarded

visibility'channel' | 'public' required

Which is the visibility of forwarded message (channel or public link)

channel_idstring nullable

Channel ID where forwarded/shared message was sent to

message_idstring nullable

Message ID that has the forward_id attached to

created_atnumber required
last_updated_atnumber required
end_access_atnumber nullable

Date when the access to forwarded message ends

revoked_atnumber nullable
revoked_bystring nullable

Example response

{
  "created_at": 1694313500106,
  "last_updated_at": 1694313500106,
  "revoked_at": 1694313500106,
  "forwarded_message": {
    "created_at": 1694313500106,
    "last_updated_at": 1694313500106
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.