> ## Documentation Index > Fetch the complete documentation index at: https://docs.serval.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Ticket > Create a new ticket. ## OpenAPI ````yaml /sections/api-reference/openapi-spec-v2.yaml post /v2/tickets openapi: 3.1.0 info: title: Serval Public API description: Serval Public API contact: name: Serval url: https://serval.com email: support@serval.com license: name: Serval License url: https://serval.com/license version: 2.0.0 servers: - url: https://public.api.serval.com security: - BearerAuth: [] tags: - name: Access Policy API - name: Access Policy Approval Procedure API - name: Access Profile API - name: Access Relationship API - name: Access Request API - name: Agent API - name: App Instance API - name: App Resource API - name: App Resource Role API - name: Approval Delegation API - name: Approval Request API - name: Audit Log API - name: Change Blackout API - name: Change Model API - name: Custom Field API - name: Custom Service API - name: Entity API - name: Entity Field Mapping API - name: Entity Ingestion Config API - name: Entity Type API - name: Folder API - name: Group API - name: Guidance API - name: Help Agent API - name: Journey API - name: Knowledge API - name: Knowledge Base API - name: Report API - name: SLA API - name: Schedule API - name: Tag API - name: Team API - name: Team User API - name: Ticket API - name: Topic API - name: User API - name: User Relationship API - name: Workflow API - name: Workflow Approval Procedure API - name: Workflow Run API paths: /v2/tickets: post: tags: - Ticket API summary: Create Ticket description: Create a new ticket. operationId: svrelay.publicv2.PublicAPIServiceV2.CreateTicket requestBody: content: application/json: schema: $ref: '#/components/schemas/svhelp.publicapi.CreateTicketRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/svhelp.publicapi.CreateTicketResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/connect.error' security: - BearerAuth: [] components: schemas: svhelp.publicapi.CreateTicketRequest: type: object properties: teamId: type: string title: team_id x-stainless-terraform-configurability: optional name: type: string title: name x-stainless-terraform-configurability: optional description: type: string title: description x-stainless-terraform-configurability: optional createdByUserId: type: string title: created_by_user_id x-stainless-terraform-configurability: optional createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at nullable: true x-stainless-terraform-configurability: optional assignedToUserId: type: string title: assigned_to_user_id nullable: true x-stainless-terraform-configurability: optional parentTicketId: type: string title: parent_ticket_id description: >- Optional. The ID of the parent ticket (this is a special relationship type) nullable: true x-stainless-terraform-configurability: optional channelSyncTargets: type: array items: $ref: '#/components/schemas/svhelp.pubapimodels.ChannelSyncTarget' title: channel_sync_targets description: >- Note that these are ADDITIONAL sync targets. There may be some "default" sync targets for the team (e.g. ServiceNow, JSM etc). x-stainless-terraform-configurability: optional aiActive: type: boolean title: ai_active description: |- Optional. Whether AI is active for this ticket. Defaults to false. When true, Serval's AI will respond to messages on this ticket. When false, AI will not respond even if the ticket is at the AI escalation level. nullable: true x-stainless-terraform-configurability: computed_optional type: $ref: '#/components/schemas/svhelp.models.TicketType' title: type description: |- Optional. The type of ticket to create. Defaults to REQUEST. If parent_ticket_id is set, this must be TASK (or omitted, in which case TASK is used). nullable: true x-stainless-terraform-configurability: computed_optional workflowRelationship: $ref: '#/components/schemas/svhelp.pubapimodels.WorkflowRelationship' title: workflow_relationship description: |- Optional. A workflow to associate with this ticket. The workflow will show a form to collect inputs, then run when the user fills the form. nullable: true x-stainless-terraform-configurability: optional ticketRelationships: type: array items: $ref: >- #/components/schemas/svhelp.publicapi.CreateTicketRelationshipInput title: ticket_relationships description: |- Optional. Relationships to create with other tickets. For example, to indicate this ticket depends on another ticket. x-stainless-terraform-configurability: optional requesterUserId: type: string title: requester_user_id description: >- Optional. The ID of the user this ticket is created on behalf of (the requester). Defaults to created_by_user_id if not provided. Use this when creating a ticket on behalf of someone else, e.g., when creating child tasks in a journey where the requester should be the journey's requester. nullable: true x-stainless-terraform-configurability: computed_optional dueDate: $ref: '#/components/schemas/google.type.Date' title: due_date description: Optional. Due date (date only, no time component). nullable: true x-stainless-terraform-configurability: optional waitUntil: $ref: '#/components/schemas/google.protobuf.Timestamp' title: wait_until description: |- Optional. Timestamp until which this ticket is waiting. Workflow calls on this ticket will not run until this time has passed. nullable: true x-stainless-terraform-configurability: optional nameTranslations: type: object title: name_translations additionalProperties: type: string title: value description: >- Per-language translations. Key = BCP 47 language code, value = translated string. x-stainless-terraform-configurability: optional descriptionTranslations: type: object title: description_translations additionalProperties: type: string title: value x-stainless-terraform-configurability: optional ticketSubtype: type: string title: ticket_subtype description: >- Optional. The subtype of the ticket (e.g. "normal", "standard", "emergency" for CHANGE tickets). Must correspond to a configured ticket model for the given team and type. nullable: true x-stainless-terraform-configurability: optional title: CreateTicketRequest additionalProperties: false svhelp.publicapi.CreateTicketResponse: type: object properties: data: $ref: '#/components/schemas/svhelp.pubapimodels.Ticket' title: data x-stainless-terraform-configurability: optional title: CreateTicketResponse additionalProperties: false connect.error: type: object properties: code: type: string examples: - not_found enum: - canceled - unknown - invalid_argument - deadline_exceeded - not_found - already_exists - permission_denied - resource_exhausted - failed_precondition - aborted - out_of_range - unimplemented - internal - unavailable - data_loss - unauthenticated description: >- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. x-stainless-terraform-configurability: optional message: type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. x-stainless-terraform-configurability: optional detail: $ref: '#/components/schemas/google.protobuf.Any' x-stainless-terraform-configurability: optional title: Connect Error additionalProperties: true description: >- Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation google.protobuf.Timestamp: type: string format: date-time description: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z"). svhelp.pubapimodels.ChannelSyncTarget: type: object oneOf: - $ref: '#/components/schemas/svhelp.pubapimodels.ChannelSyncTarget.Email' - $ref: >- #/components/schemas/svhelp.pubapimodels.ChannelSyncTarget.MicrosoftTeamsDm - $ref: '#/components/schemas/svhelp.pubapimodels.ChannelSyncTarget.SlackDm' title: ChannelSyncTarget svhelp.models.TicketType: type: string title: TicketType enum: - TICKET_TYPE_UNSPECIFIED - TICKET_TYPE_REQUEST - TICKET_TYPE_TASK - TICKET_TYPE_MAJOR_INCIDENT - TICKET_TYPE_CONVERSATION - TICKET_TYPE_JOURNEY - TICKET_TYPE_JOURNEY_CONVERSATION - TICKET_TYPE_INCIDENT - TICKET_TYPE_CHANGE - TICKET_TYPE_CUSTOM svhelp.pubapimodels.WorkflowRelationship: type: object properties: workflowId: type: string title: workflow_id description: The workflow ID. x-stainless-terraform-configurability: optional relationshipType: $ref: '#/components/schemas/svhelp.pubapimodels.WorkflowRelationshipType' title: relationship_type description: The type of relationship between the ticket and workflow. x-stainless-terraform-configurability: optional initialInputData: type: object title: initial_input_data additionalProperties: $ref: '#/components/schemas/svhelp.pubapimodels.InitialInputDataValue' title: value description: |- Optional initial input data to pre-populate workflow form fields. Keys are parameter names, values describe how to resolve the initial value. These become the workflow call's arguments (default values for the form). x-stainless-terraform-configurability: computed_optional allowAssigneeRetry: type: boolean title: allow_assignee_retry description: >- Whether the journey-assigned user is allowed to retry this workflow if it fails. Defaults to false (only team members can retry). x-stainless-terraform-configurability: computed_optional pollingIntervalMs: type: - integer - string title: polling_interval_ms format: int64 description: >- Required when relationship_type is STATUS_CHECK. Interval in milliseconds between polls. nullable: true x-stainless-terraform-configurability: optional timeoutMs: type: - integer - string title: timeout_ms format: int64 description: >- Optional deadline in milliseconds from the first poll. The status check auto-fails after this time. nullable: true x-stainless-terraform-configurability: optional autoSubmitInputs: type: boolean title: auto_submit_inputs description: >- When true, the workflow runs automatically once dependencies are met instead of waiting for a person. Only valid for REQUIRED relationships whose initial_input_data covers every required parameter. x-stainless-terraform-configurability: computed_optional title: WorkflowRelationship additionalProperties: false description: Represents a workflow relationship on a ticket. svhelp.publicapi.CreateTicketRelationshipInput: type: object properties: ticketId: type: string title: ticket_id description: The ID of the related ticket (must already exist). x-stainless-terraform-configurability: optional relationshipType: $ref: '#/components/schemas/svhelp.pubapimodels.TicketRelationshipType' title: relationship_type description: The type of relationship. x-stainless-terraform-configurability: optional title: CreateTicketRelationshipInput additionalProperties: false description: >- Input for creating a relationship between the new ticket and an existing ticket. google.type.Date: type: object properties: year: type: integer title: year format: int32 description: >- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. x-stainless-terraform-configurability: optional month: type: integer title: month format: int32 description: >- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. x-stainless-terraform-configurability: optional day: type: integer title: day format: int32 description: >- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. x-stainless-terraform-configurability: optional title: Date additionalProperties: false description: >- Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * [google.type.TimeOfDay][google.type.TimeOfDay] * [google.type.DateTime][google.type.DateTime] * [google.protobuf.Timestamp][google.protobuf.Timestamp] svhelp.pubapimodels.Ticket: type: object properties: id: type: string title: id description: The ID of the Serval ticket. readOnly: true x-stainless-terraform-configurability: computed friendlyIdentifier: type: string title: friendly_identifier description: >- A friendly identifier for the ticket. This is a unique identifier for the ticket that is displayed to the user. It is a combination of the team prefix (configured in Settings > Organization Settings > Teams) and the ticket number. Example: For the Acme team's 10th ticket, the friendly identifier is "ACM-10". readOnly: true x-stainless-terraform-configurability: computed teamId: type: string title: team_id description: The ID of the team that the ticket belongs to. x-stainless-terraform-configurability: optional name: type: string title: name description: A name or title for the ticket. x-stainless-terraform-configurability: optional description: type: string title: description description: A description of the ticket. x-stainless-terraform-configurability: optional createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: >- Timestamp indicating when the ticket was created. Will be in RFC 3339 format (e.g., "2017-01-15T01:30:15.01Z"). readOnly: true x-stainless-terraform-configurability: computed completedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: completed_at description: >- Timestamp indicating when the ticket was completed. Will be in RFC 3339 format (e.g., "2017-01-15T01:30:15.01Z"). nullable: true readOnly: true x-stainless-terraform-configurability: computed escalatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: escalated_at description: >- Timestamp indicating when the ticket was escalated. Will be in RFC 3339 format (e.g., "2017-01-15T01:30:15.01Z"). nullable: true readOnly: true x-stainless-terraform-configurability: computed createdByUserId: type: string title: created_by_user_id description: The ID of the user who created the ticket. x-stainless-terraform-configurability: optional assignedToUserId: type: string title: assigned_to_user_id description: >- The ID of the user who is assigned to the ticket. Optional if the ticket is not assigned to a user. nullable: true x-stainless-terraform-configurability: optional requesterUserId: type: string title: requester_user_id description: >- The ID of the user this ticket was created on behalf of (the requester). x-stainless-terraform-configurability: optional statusId: type: string title: status_id description: The ID of the status option for the ticket. x-stainless-terraform-configurability: optional escalationLevel: $ref: '#/components/schemas/svhelp.models.TicketEscalationLevel' title: escalation_level description: The escalation level of the ticket. x-stainless-terraform-configurability: optional priorityId: type: string title: priority_id description: The ID of the priority option for the ticket. x-stainless-terraform-configurability: optional slaStartedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: sla_started_at description: >- Timestamp indicating when the SLA started. Will be in RFC 3339 format (e.g., "2017-01-15T01:30:15.01Z"). nullable: true readOnly: true x-stainless-terraform-configurability: computed slaBreachesAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: sla_breaches_at description: >- Timestamp indicating when the SLA was breached. Will be in RFC 3339 format (e.g., "2017-01-15T01:30:15.01Z"). nullable: true readOnly: true x-stainless-terraform-configurability: computed labelIds: type: array items: type: string title: label_ids description: List of label IDs for the ticket. x-stainless-terraform-configurability: optional type: $ref: '#/components/schemas/svhelp.models.TicketType' title: type description: >- The type of ticket. Possible values: TICKET_TYPE_REQUEST, TICKET_TYPE_TASK, TICKET_TYPE_INCIDENT, TICKET_TYPE_MAJOR_INCIDENT, TICKET_TYPE_JOURNEY. x-stainless-terraform-configurability: optional dueDate: $ref: '#/components/schemas/google.type.Date' title: due_date description: Due date (date only, no time component). nullable: true readOnly: true x-stainless-terraform-configurability: computed isOverdue: type: boolean title: is_overdue description: True if the due date has passed (computed server-side). readOnly: true x-stainless-terraform-configurability: computed childTicketIds: type: array items: type: string readOnly: true title: child_ticket_ids description: IDs of child (task) tickets under this ticket. readOnly: true x-stainless-terraform-configurability: computed linkedTicketIds: type: array items: type: string readOnly: true title: linked_ticket_ids description: IDs of tickets linked to this ticket. readOnly: true x-stainless-terraform-configurability: computed duplicateTicketIds: type: array items: type: string readOnly: true title: duplicate_ticket_ids description: IDs of tickets marked as duplicates of this ticket. readOnly: true x-stainless-terraform-configurability: computed dependsOnTicketIds: type: array items: type: string readOnly: true title: depends_on_ticket_ids description: IDs of tickets that this ticket depends on. readOnly: true x-stainless-terraform-configurability: computed parentTicketId: type: string title: parent_ticket_id description: >- The ID of this ticket's parent ticket. Only set for task tickets that have a parent. nullable: true readOnly: true x-stainless-terraform-configurability: computed conversationThreadTicketIds: type: array items: type: string readOnly: true title: conversation_thread_ticket_ids description: IDs of conversation thread tickets on this ticket. readOnly: true x-stainless-terraform-configurability: computed conversationThreadParentTicketId: type: string title: conversation_thread_parent_ticket_id description: >- The ID of the main ticket this thread belongs to. Only set for conversation thread tickets. nullable: true readOnly: true x-stainless-terraform-configurability: computed nameTranslations: type: object title: name_translations additionalProperties: type: string title: value description: >- Per-language translations for the ticket name. Key = BCP 47 language code. x-stainless-terraform-configurability: optional descriptionTranslations: type: object title: description_translations additionalProperties: type: string title: value description: >- Per-language translations for the ticket description. Key = BCP 47 language code. x-stainless-terraform-configurability: optional categoryOptionId: type: string title: category_option_id description: |- The ID of the category option currently set on the ticket. May be a top-level category or a nested subcategory. Absent when the ticket has no category. nullable: true x-stainless-terraform-configurability: optional title: Ticket additionalProperties: false google.protobuf.Any: type: object properties: type: type: string x-stainless-terraform-configurability: optional value: type: string format: binary x-stainless-terraform-configurability: optional debug: type: object additionalProperties: true x-stainless-terraform-configurability: optional additionalProperties: true description: >- Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. svhelp.pubapimodels.ChannelSyncTarget.Email: type: object title: Email properties: email: $ref: '#/components/schemas/svhelp.pubapimodels.EmailTarget' title: email x-stainless-terraform-configurability: optional required: - email additionalProperties: false svhelp.pubapimodels.ChannelSyncTarget.MicrosoftTeamsDm: type: object title: Microsoft Teams Dm properties: microsoftTeamsDm: $ref: '#/components/schemas/svhelp.pubapimodels.MicrosoftTeamsDMTarget' title: microsoft_teams_dm x-stainless-terraform-configurability: optional required: - microsoftTeamsDm additionalProperties: false svhelp.pubapimodels.ChannelSyncTarget.SlackDm: type: object title: Slack Dm properties: slackDm: $ref: '#/components/schemas/svhelp.pubapimodels.SlackDMTarget' title: slack_dm x-stainless-terraform-configurability: optional required: - slackDm additionalProperties: false svhelp.pubapimodels.WorkflowRelationshipType: type: string title: WorkflowRelationshipType enum: - WORKFLOW_RELATIONSHIP_TYPE_UNSPECIFIED - WORKFLOW_RELATIONSHIP_TYPE_REQUIRED - WORKFLOW_RELATIONSHIP_TYPE_STATUS_CHECK description: The type of relationship between a ticket and a workflow. svhelp.pubapimodels.InitialInputDataValue: type: object oneOf: - $ref: >- #/components/schemas/svhelp.pubapimodels.InitialInputDataValue.EntityFieldReference - $ref: >- #/components/schemas/svhelp.pubapimodels.InitialInputDataValue.Static title: InitialInputDataValue description: |- Represents a single initial input data value for a workflow form field. Supports static values and entity field references. svhelp.pubapimodels.TicketRelationshipType: type: string title: TicketRelationshipType enum: - TICKET_RELATIONSHIP_TYPE_UNSPECIFIED - TICKET_RELATIONSHIP_TYPE_DUPLICATE - TICKET_RELATIONSHIP_TYPE_LINKED - TICKET_RELATIONSHIP_TYPE_PARENT - TICKET_RELATIONSHIP_TYPE_DEPENDS_ON - TICKET_RELATIONSHIP_TYPE_CONVERSATION_THREAD description: >- TicketRelationshipType represents the type of relationship between two tickets svhelp.models.TicketEscalationLevel: type: string title: TicketEscalationLevel enum: - AI - HUMAN svhelp.pubapimodels.EmailTarget: type: object properties: targetUserType: $ref: '#/components/schemas/svhelp.pubapimodels.ChannelSyncTargetUserType' title: target_user_type x-stainless-terraform-configurability: optional title: EmailTarget additionalProperties: false svhelp.pubapimodels.MicrosoftTeamsDMTarget: type: object properties: targetUserType: $ref: '#/components/schemas/svhelp.pubapimodels.ChannelSyncTargetUserType' title: target_user_type x-stainless-terraform-configurability: optional title: MicrosoftTeamsDMTarget additionalProperties: false svhelp.pubapimodels.SlackDMTarget: type: object properties: targetUserType: $ref: '#/components/schemas/svhelp.pubapimodels.ChannelSyncTargetUserType' title: target_user_type x-stainless-terraform-configurability: optional title: SlackDMTarget additionalProperties: false svhelp.pubapimodels.InitialInputDataValue.EntityFieldReference: type: object title: Entity Field Reference properties: entityFieldReference: $ref: '#/components/schemas/svhelp.pubapimodels.EntityFieldReference' title: entity_field_reference description: |- A reference to a field value on an entity in the entity store. Resolved on-demand to provide fresh data. x-stainless-terraform-configurability: optional required: - entityFieldReference additionalProperties: false description: |- A reference to a field value on an entity in the entity store. Resolved on-demand to provide fresh data. svhelp.pubapimodels.InitialInputDataValue.Static: type: object title: Static properties: static: $ref: '#/components/schemas/google.protobuf.Value' title: static description: A static value to use as the default for this form field. x-stainless-terraform-configurability: optional required: - static additionalProperties: false description: A static value to use as the default for this form field. svhelp.pubapimodels.ChannelSyncTargetUserType: type: string title: ChannelSyncTargetUserType enum: - CHANNEL_SYNC_USER_TYPE_UNSPECIFIED - CHANNEL_SYNC_TARGET_USER_TICKET_ASSIGNEE - CHANNEL_SYNC_TARGET_USER_TICKET_REQUESTOR svhelp.pubapimodels.EntityFieldReference: type: object properties: entityTypeKey: type: string title: entity_type_key description: The entity type key (e.g., "employee", "customer"). x-stainless-terraform-configurability: optional entityKey: type: string title: entity_key description: The entity key (e.g., "john-doe", "acme-corp"). x-stainless-terraform-configurability: optional fieldKey: type: string title: field_key description: The field key on the entity (e.g., "country", "department"). x-stainless-terraform-configurability: optional title: EntityFieldReference additionalProperties: false description: |- References a specific field value on an entity in the entity store. Resolved on-demand to provide fresh data whenever arguments are read. google.protobuf.Value: oneOf: - type: 'null' - type: number - type: string - type: boolean - type: array - type: object additionalProperties: true description: |- `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. The JSON representation for `Value` is JSON value. securitySchemes: BearerAuth: type: http scheme: bearer ````