Conversations (Forwards)

Create forward by conversation

Changed on

Creates a forward to send through email. Forwards will send all messages in a conversation.

NOTE

To schedule the forward for delivery, create a forward with a sendAt property.

Any one of the following roles is required for this endpoint:

Legacy RoleEquivalent Permission Set Role
org.user.conversation_forward.writeorg.permission.conversation_forward.create
post/conversations/{id}/forwards

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/conversations/{id}/forwards
  • Auth: httpBearer (a scheme the document does not define)

Path parameters

idstring required
Example:58210c3db0f09110006b7954

Unique ID of the conversation.

Request body

channel'email' required
app'gmail' | 'postmark'
customerstring object-id
status'draft' | 'sent' | 'failed'
sendAtstring date-time-math
bodystring
subjectstring
replyTostring email-relaxed
templatestring object-id nullable
payloadobject

Response

OK

Changes

  • 0d6c566968faRevision changes
    • info

      api operation id CreateaForwardByConversation removed and replaced with CreateForwardByConversation