conversations

Create a new outbound ticket and send the first message to the customer.

Idempotent within a short window: an identical compose retried while the first is still in flight returns 409, and one retried after it committed returns the same ticket with a 200. Only a genuinely new request creates a ticket and emails the customer.

post/api/projects/{project_id}/conversations/tickets/compose/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/conversations/tickets/compose/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

recipient_emailstring email required

Recipient email address.

recipient_distinct_idstring

PostHog distinct_id to link the ticket to a person. Falls back to recipient_email.

email_subjectstring

Email subject line.

email_config_idstring uuid required

ID of the EmailChannel to send from.

messagestring required

Message content in markdown.

rich_contentunknown
tagsstring[]

Tags to apply to the new ticket, e.g. to mark its source. Each is normalized (lowercased, trimmed). Up to 100.

Response

An identical compose was already handled; the existing ticket is returned.

idstring uuid required

Created ticket UUID.

ticket_numberinteger required

Human-readable ticket number.

Changes

No recorded changes to this operation across all 1 revision of this API.