Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Create a Draft by Customer

Create an outbound draft to a customer through a channel.

You can also create note drafts by specifying the channel as 'note'. You can have one note draft per conversation.

Rate Limit

Customer drafts are subject to a rate limit. A single client can create up to 120 drafts per minute per customer, including drafts scheduled for the future.

A 429 Too Many Requests response will be returned if the rate limit has been reached for a customer.

Input

type: object properties: parameters: type: object properties: id: type: string description: (Required) Unique ID of the customer. 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 \"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 \"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 \"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 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