Inbox

Create Thread

Create a new inbox thread from an external source (e.g., contact form, CRM, or custom integration).

NOTE: thread_type must be one of contact_form, callback, feedback, newsletter, channel_message. status accepts open or pending (default: open); legacy aliases are normalized before storage. domain_id (the business the thread belongs to) can be omitted when the account has one business; with several, the validation error lists the available ids and names.

post/inbox

Request

  • Base URL
    https://app.boei.help/api/v1
  • Auth
    HTTP bearer

Request body

thread_typestring required

The thread type.

subjectstring nullable

Thread subject.

sender_namestring nullable

Sender's name.

sender_emailstring nullable

Sender's email.

sender_phonestring nullable

Sender's phone.

messagestring required

The initial message body.

contact_idstring nullable

Link to existing contact.

domain_idinteger nullable

The business (domain) this thread belongs to. Optional when the account has exactly one business.

statusstring nullable

Initial status: open or pending (default: open).

Example request

{
  "thread_type": "contact_form",
  "subject": "Question about pricing",
  "sender_name": "John Doe",
  "sender_email": "john@example.com",
  "sender_phone": "+1234567890",
  "message": "I would like to know more about your enterprise plan.",
  "contact_id": "con_abc123",
  "domain_id": 42,
  "status": "open"
}

Response

Example response

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "thread_type": "contact_form",
    "status": "open",
    "customer": "John Doe",
    "email": "john@example.com",
    "message_count": 1
  }
}

Changes

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