Message Share Links

Create a MessageShareLink

post/message-sharelinks

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/message-sharelinks
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Request body

shared_message_idstring required

Message ID that will be shared/forwarded

share_type'forward' | 'link' required

What is the ShareType of the MessageShareLink

message_idstring nullable

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

access_type'public' | 'specified' | 'forward' required

What is the access type for the MessageShareLink

end_access_atstring date-time nullable

Date when the access to MessageShareLink ends

reply_type'shared' | 'private_only' nullable

How replies to this share link behave. "shared" allows replies to go to a shared conversation (POST /channels/sharelink/{share_link_id}); "private_only" keeps the legacy behavior where each reply is a private DM to the sharer. Only valid when share_type is link. Omitted = private_only (legacy default).

Response

_idstring required

Unique Identifier of share link

created_bystring required

Identifier of the User who created the share/forward

channel_idstring nullable

Channel ID where forwarded message was sent to

message_idstring nullable

Message ID that has the share_link_id attached to

created_atnumber required
last_updated_atnumber required
end_access_atnumber nullable

Date when the access to shared message ends

revoked_atnumber nullable
revoked_bystring nullable
share_type'forward' | 'link' required

What is the ShareType of the MessageShareLink

access_type'public' | 'specified' | 'forward' required

What is the access type for the MessageShareLink

reply_type'shared' | 'private_only' required

How replies to this share link behave. Legacy links without the field are private_only.

reply_conversation_idstring nullable

Conversation holding the shared replies to this link, if one was already created

Example response

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

Changes

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