Kustomer API
Getting access, Developing, Testing
Back to Kustomer
Update a Draft
Updates a draft. Any properties available in the channel can be updated via this endpoint. If the sendAt property is updated to a valid timestamp, the draft will be scheduled to be sent. If the sendAt property is empty, the draft will be unscheduled. If the sendAt property is not included, the draft's status will not be affected.
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
description: (Required) Draft ID
required:
- id
title: Parameters
data:
type: string
example: >-
"{\n \"channel\": \"<string>\",\n \"conversation\":
\"<object-id>\",\n \"app\": \"<string>\",\n \"customer\":
\"<object-id>\",\n \"auto\": \"<boolean>\",\n \"scheduled\":
\"<boolean>\",\n \"sendAt\": \"<date-time-math>\",\n \"source\":
\"<string>\",\n \"lang\": \"<string>\",\n \"shortcuts\": [\n
\"<object-id>\",\n \"<object-id>\"\n ],\n \"kbArticles\":
[\n \"<object-id>\",\n \"<object-id>\"\n ],\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
\"htmlBody\": \"<string>\",\n \"cc\": [\n {\n
\"email\": \"<email-relaxed>\",\n \"name\":
\"<string>\"\n },\n {\n \"email\":
\"<email-relaxed>\",\n \"name\": \"<string>\"\n }\n
],\n \"bcc\": [\n {\n \"email\":
\"<email-relaxed>\",\n \"name\": \"<string>\"\n
},\n {\n \"email\": \"<email-relaxed>\",\n
\"name\": \"<string>\"\n }\n ],\n \"subject\":
\"<string>\",\n \"replyTo\": \"<email-relaxed>\",\n \"headers\":
[\n {\n \"name\": \"<string>\",\n \"value\":
\"<string>\"\n },\n {\n \"name\":
\"<string>\",\n \"value\": \"<string>\"\n }\n ],\n
\"templateType\": \"<string>\",\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:
channel:
type: string
body:
type: string
status:
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