tickets

Update a ticket

Updates an existing ticket.

PATCH

/v1/tickets/{id}

Update a ticket

curl --request PATCH \
  --url https://api.beamdynamics.io/v1/tickets/{id} \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assigneeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assigneeIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "attributes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contactEmail": "jsmith@example.com",
  "contactEntityId": "<string>",
  "contactEntityIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "dueDate": "2023-12-25",
  "fields": [
    {
      "content": "<string>",
      "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "maintenanceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "priority": "urgent",
  "shouldReturn": true,
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subStatus": "<string>",
  "ticketTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>"
}
'

{
  "createdAt": "<string>",
  "description": "<string>",
  "dueDate": "<string>",
  "id": 123,
  "priority": "urgent",
  "seqId": 123,
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "studioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ticketTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "updatedAt": "<string>"
}

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idintegerrequired

Required range: 0 < x

Body

assigneeIdstring | null

assigneeIdsstring[] | null

attributesstring[] | null

categoryIdstring | null

contactEmailstring | null

contactEntityIdstring | null

contactEntityIdsstring[] | null

descriptionstring | null

dueDatestring | null

fieldsobject[]

Show child attributes

maintenanceIdstring | null

priorityenum<string> | null

Available options: urgent, important, non-critical, uncertain

shouldReturnboolean

statusIdstring

subStatusstring | null

ticketTypeIdstring

titlestring

Response

The updated ticket

createdAtstringrequired

descriptionstring | nullrequired

dueDatestring | nullrequired

idnumberrequired

priorityenum<string>required

Available options: urgent, important, non-critical, uncertain

seqIdnumberrequired

statusIdstringrequired

studioIdstringrequired

ticketTypeIdstring | nullrequired

titlestringrequired

updatedAtstringrequired

Still need help? Ask the team