Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Create a Forward by Conversation

Create a forward that will be sent via email.

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

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.conversation_forward.write|org.permission.conversation_forward.create|

NOTE

Creating a forward with a sendAt property will schedule the forward for delivery. Forwards will send all messages in a conversation.

Input

type: object properties: parameters: type: object properties: id: type: string description: (Required) Conversation ID required: - id title: Parameters data: type: string example: >- "{\n \"channel\": \"<string>\",\n \"app\": \"<string>\",\n \"customer\": \"<object-id>\",\n \"status\": \"<string>\",\n \"sendAt\": \"<date-time-math>\",\n \"to\": [\n {\n \"email\": \"<email-relaxed>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email-relaxed>\",\n \"name\": \"<string>\"\n }\n ],\n \"from\": {\n \"email\": \"<email-relaxed>\",\n \"name\": \"<string>\"\n },\n \"body\": \"<string>\",\n \"subject\": \"<string>\",\n \"replyTo\": \"<email-relaxed>\",\n \"template\": \"<object-id>\",\n \"payload\": \"<object>\"\n}" title: Data

Output

type: object properties: data: type: object properties: id: type: string type: type: string attributes: type: object properties: app: type: string channel: type: string status: type: string from: type: object properties: name: type: string email: type: string to: type: array items: type: object properties: name: type: string email: type: string createdAt: type: string updatedAt: type: string modifiedAt: type: string relationships: type: object properties: org: type: object properties: data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string customer: type: object properties: data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string conversation: type: object properties: data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string createdBy: type: object properties: data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string modifiedBy: type: object properties: data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string