POST/desk/api/v2/conversations/{id}/convert.json

Converts a conversation to a ticket

Path Params

  • Name
    id
    Type
    integer
    required
    Description

Body Params

    • Name
      agent
      Type
      object
    • Name
      bcc
      Type
      array
      Description
      List of BCC for the initial message
    • Name
      cc
      Type
      array
      Description
      List of CC for the initial message
    • Name
      customer
      Type
      object
      Description
      Customer ID or Email is required, but not both.
    • Name
      customfields
      Type
      array
      Description
      The list of custom fields for available to the ticket
    • Name
      editMethod
      Type
      string
      Description
      The default input method for editing tickets. Options are html and markdown.
    • Name
      email
      Type
      string
      Description
      The email of a customer that should be created and then associated with the ticket. DEPRECATED please use customer.email
    • Name
      files
      Type
      array
      Description
      List of attachment
    • Name
      fromThreadId
      Type
      integer
      Description
      When set, this message body and customer will be used to create this ticket, FromTicketID is also required if ticket is archived
    • Name
      fromTicketId
      Type
      integer
      Description
      When set, the message body and customer from the thread specified in FromThreadID will be used to create this ticket, this field is only required if ticket is archived
    • Name
      inbox
      Type
      object
    • Name
      message
      Type
      string
      Description
      The ticket's initial message
    • Name
      notifyCustomer
      Type
      boolean
      Description
      Whether to notify the customer when an agent creates a ticket on behalf of the customer
    • Name
      parent
      Type
      object
    • Name
      priority
      Type
      object
    • Name
      scheduledEmail
      Type
      object
      Description
      ScheduledEmail represents a ScheduledEmail.
    • Name
      sendFrom
      Type
      string
      Description
      Use an inbox alias to send email notifications
    • Name
      source
      Type
      object
    • Name
      status
      Type
      object
    • Name
      subject
      Type
      string
      Description
      The ticket's subject
    • Name
      tags
      Type
      array
      Description
      The list of word the ticket was tagged with
    • Name
      tickettemplate
      Type
      object
    • Name
      type
      Type
      object

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
      Conversation represents a Conversation.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    200 OK

    Conversation
    {
  "contact": {
    "createdAt": "2024-12-19T16:02:34.102Z",
    "createdBy": {
      "delete": true,
      "id": 0,
      "meta": {
        "additionalProp": "Unknown Type: any"
      },
      "type": 0
    },
    "deletedAt": "2024-12-19T16:02:34.102Z",
    "deletedBy": {
      "delete": true,
      "id": 0,
      "meta": {
        "additionalProp": "Unknown Type: any"
      },
      "type": 0
    },
    "filter_args": {
      "aggregate": {
        "Distinct": true,
        "Field": "string",
        "Operation": "string"
      },
      "bulkDryExecute": true,
      "fields": [
        "string"
      ],
      "filter": [
        "string"
      ],
      "id": 0,
      "ids": [
        0
      ],
      "includes": [
        "string"
      ],
      "orderBy": "string",
      "orderMode": "asc",
      "page": 0,
      "pageOffset": 0,
      "pageSize": 0,
      "skipAggregation": true
    },
    "id": 0,
    "isMain": true,
    "pmfield": "string",
    "state": "string",
    "type": "email",
    "updatedAt": "2024-12-19T16:02:34.102Z",
    "updatedBy": {
      "delete": true,
      "id": 0,
      "meta": {
        "additionalProp": "Unknown Type: any"
      },
      "type": 0
    },
    "value": "string"
  },
  "contactId": 0,
  "createdAt": "2024-12-19T16:02:34.102Z",
  "createdBy": {
    "delete": true,
    "id": 0,
    "meta": {
      "additionalProp": "Unknown Type: any"
    },
    "type": 0
  },
  "deletedAt": "2024-12-19T16:02:34.102Z",
  "deletedBy": {
    "delete": true,
    "id": 0,
    "meta": {
      "additionalProp": "Unknown Type: any"
    },
    "type": 0
  },
  "filter_args": {
    "aggregate": {
      "Distinct": true,
      "Field": "string",
      "Operation": "string"
    },
    "bulkDryExecute": true,
    "fields": [
      "string"
    ],
    "filter": [
      "string"
    ],
    "id": 0,
    "ids": [
      0
    ],
    "includes": [
      "string"
    ],
    "orderBy": "string",
    "orderMode": "asc",
    "page": 0,
    "pageOffset": 0,
    "pageSize": 0,
    "skipAggregation": true
  },
  "id": 0,
  "messages": [
    {
      "delete": true,
      "id": 0,
      "meta": {
        "additionalProp": "Unknown Type: any"
      },
      "type": 0
    }
  ],
  "socket_id": "string",
  "state": "string",
  "ticket_id": 0,
  "token": "string",
  "updatedAt": "2024-12-19T16:02:34.102Z",
  "updatedBy": {
    "delete": true,
    "id": 0,
    "meta": {
      "additionalProp": "Unknown Type: any"
    },
    "type": 0
  },
  "users": [
    {
      "delete": true,
      "id": 0,
      "meta": {
        "additionalProp": "Unknown Type: any"
      },
      "type": 0
    }
  ]
}
    Download Swagger