# Create message

Create message. See the OpenAPI-defined parameters, request body, and responses below.

Source: https://zild.ai/en-US/docs/api-reference/post-api-Message

POST `/Message`

Create message. See the OpenAPI-defined parameters, request body, and responses below.

**OpenAPI description:** Este endpoint cria uma nova mensagem, opcionalmente com arquivo, para uma conversa.

## Authentication

**Authentication required.** Send your user API key in the X-API-Key header.

## Parameters

This operation has no path, query, or header parameters.

## Request body

**Content type:** `multipart/form-data` · **Schema:** `object`



<table class="api-params"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>file</code></td><td><code>string · binary</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>Id</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>CreatedAt</code></td><td><code>string · date-time</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>From</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>To</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>Content</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>ConversationId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>Sentiment</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>Offset</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>IsNPS</code></td><td><code>boolean</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>ContentSid</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>MessageType</code></td><td><code>MessageType</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>ConversationTemplateId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>MediaUrl</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>MediaFileName</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>TenantId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>UserId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>ContentVariables</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>MessageSid</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>MessageStatus</code></td><td><code>MessageStatus</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>Sent</code></td><td><code>boolean</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>Delivered</code></td><td><code>boolean</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>Read</code></td><td><code>boolean</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>ErrorCode</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>ErrorMessage</code></td><td><code>string</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>IsReadByUser</code></td><td><code>boolean</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>DocumentId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr></tbody></table>



## Example request



```
curl --request POST \
  --url 'https://api.zild.ai/Message' \
  --header 'X-API-Key: YOUR_USER_API_KEY' \
  --form 'file=@file' \
  --form 'Id={Id}' \
  --form 'CreatedAt={CreatedAt}' \
  --form 'From={From}' \
  --form 'To={To}' \
  --form 'Content={Content}' \
  --form 'ConversationId={ConversationId}' \
  --form 'Sentiment={Sentiment}' \
  --form 'Offset={Offset}' \
  --form 'IsNPS={IsNPS}' \
  --form 'ContentSid={ContentSid}' \
  --form 'MessageType={MessageType}' \
  --form 'ConversationTemplateId={ConversationTemplateId}' \
  --form 'MediaUrl={MediaUrl}' \
  --form 'MediaFileName={MediaFileName}' \
  --form 'TenantId={TenantId}' \
  --form 'UserId={UserId}' \
  --form 'ContentVariables={ContentVariables}' \
  --form 'MessageSid={MessageSid}' \
  --form 'MessageStatus={MessageStatus}' \
  --form 'Sent={Sent}' \
  --form 'Delivered={Delivered}' \
  --form 'Read={Read}' \
  --form 'ErrorCode={ErrorCode}' \
  --form 'ErrorMessage={ErrorMessage}' \
  --form 'IsReadByUser={IsReadByUser}' \
  --form 'DocumentId={DocumentId}'
```



## Responses



<table class="api-params"><thead><tr><th>Status</th><th>Description</th><th>Response body</th></tr></thead><tbody><tr><td><code>200</code></td><td>Mensagem criada com sucesso</td><td>No response body is defined.</td></tr></tbody></table>



## Data models

`MessageStatus`0 = Queued; 1 = Sending; 2 = Sent; 3 = Delivered; 4 = Receiving; 5 = Received; 6 = Accepted; 7 = Scheduled; 8 = Read; 9 = Undelivered; 10 = Canceled; 11 = Failed

`integer`

`MessageType`0 = Text; 1 = Image; 2 = File; 3 = Audio; 4 = Video; 5 = Internal; 6 = TemplateMarketing; 7 = TemplateUtility; 8 = Location; 9 = Contact

`integer`
