Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Update a Draft Forward

Updates a forward. If the sendAt property is updated to a valid timestamp, the forward will be scheduled to be sent and updated to a scheduled status. If the sendAt property is not included, the draft's status will not be affected.

Request Body Details

| Name | Detail | | ------------- | ------------- | | body | The message body included with the forwarded conversation. | | from | The email address sending the forward. | | lang | Describes the language of the object's contents | | sendAt | A date in ISO format. Including this property will schedule the forward to be delivered. | | status | The status of the forward. A draft status indicates the forward is not scheduled for delivery and still editable. A scheduled status indicates the forward is scheduled for delivery by an email app (postmark or gmail). A draft will be update to a failed or sent status after a delivery attempt. | | subject | The subject of the forwarded conversation. | | template | The ID of a template that should be used for the forward. | | to | The destination email address of the forward. This an array that can accept more than one email recipient. |

Input

type: object properties: parameters: type: object properties: id: type: string description: | (Required) Draft Forward ID required: - id title: Parameters data: type: string example: >- "{\n \"status\": \"<string>\",\n \"sendAt\": \"<date-time-math>\",\n \"lang\": \"<string>\",\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 body: 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 sendAt: 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 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