Create a ticket

post

https://api.heymantle.com/v1/tickets

Create a new ticket. Can associate multiple contacts. Use PUT /tickets/{id}/messages and PUT /tickets/{id}/events endpoints to bulk upsert messages and events.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

subject

string

required

The subject line of the ticket

status

string

enum

Defaults to open

The status of the ticket

Allowed:

priority

string

enum

Defaults to normal

The priority level of the ticket

Allowed:

tags

contactId

string

The ID of the primary contact

contactIds

array of strings

Array of contact IDs to associate with the thread (in addition to the primary contactId)

contactIds

customerId

string

The ID of the customer

channelId

string

The ID of the channel to attribute this ticket to. If omitted, the
ticket is placed on a per-organization "API" chat channel that is
created on first use.

appId

string

The ID of the app

assignedToId

string

The ID of the assigned agent

createdAt

date-time

When the ticket was created

updatedAt

date-time

When the ticket was last updated

lastMessageAt

date-time

When the last message was sent

readOnly

boolean

Whether the ticket is read-only

managedBy

string

What manages this ticket (e.g., "intercom", "zendesk")

contact

object

Contact object to upsert (if contactId not provided)

inboxId

string | null

Assign the ticket to this Inbox. Must belong to the organization.

cxEmailAddressId

string | null

Preferred outbound sender (CXEmailAddress) for emails on this
ticket. Must have useForOutbound: true. When omitted, the
channel's default outbound address is used at send time.

send

boolean

Defaults to false

When true, the ticket (and any inline message) is
processed as a real ticket would be: configured
automations, notifications, and outbound delivery run.
When false (or omitted), the ticket is persisted without
triggering any side effects.

message

object | null

Optional initial message to create with the ticket. When
send: true with actorType: agent, the outbound email
sender is selected automatically from the organization's
configured email channels; the ticket's channelId is not
used for delivery in that case.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created ticket.

400Invalid request

401Unauthorized

403Forbidden