API
/web_api/public/helpdesk/tickets
/web_api/public/helpdesk/tickets
This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.
Request
main-app://schemas/api_public_helpdesk/tickets.request.json
POST /web_api/public/helpdesk/tickets body
| Name | Type | Required | Constraint |
|---|---|---|---|
display_name | string | Yes | - |
contact_method_key | string | Yes | - |
contact_value | string | Yes | - |
body | string | Yes | - |
pdn_consent | any | Yes | - |
locale | string | No | - |
source_page_url | string | No | - |
utm_source | string | No | - |
utm_medium | string | No | - |
utm_campaign | string | No | - |
utm_content | string | No | - |
utm_term | string | No | - |
yclid | string | No | - |
visitor_key | string | No | - |
Other top-level fields are allowed.
Response
main-app://schemas/api_public_helpdesk/tickets.response.json
POST /web_api/public/helpdesk/tickets success
| Name | Type | Required | Constraint |
|---|---|---|---|
api_code | integer | Yes | const 200 |
api_result | object | Yes | other fields allowed |
empty | boolean | No | - |
Other top-level fields are not allowed.
Source schema
The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.
Request: main-app://schemas/api_public_helpdesk/tickets.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_public_helpdesk/tickets.request.json",
"title": "POST /web_api/public/helpdesk/tickets body",
"type": "object",
"required": [
"display_name",
"contact_method_key",
"contact_value",
"body",
"pdn_consent"
],
"additionalProperties": true,
"properties": {
"display_name": {
"type": "string"
},
"contact_method_key": {
"type": "string"
},
"contact_value": {
"type": "string"
},
"body": {
"type": "string"
},
"pdn_consent": true,
"locale": {
"type": "string"
},
"source_page_url": {
"type": "string"
},
"utm_source": {
"type": "string"
},
"utm_medium": {
"type": "string"
},
"utm_campaign": {
"type": "string"
},
"utm_content": {
"type": "string"
},
"utm_term": {
"type": "string"
},
"yclid": {
"type": "string"
},
"visitor_key": {
"type": "string"
}
}
}Response: main-app://schemas/api_public_helpdesk/tickets.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_public_helpdesk/tickets.response.json",
"title": "POST /web_api/public/helpdesk/tickets success",
"allOf": [
{
"$ref": "main-app://schemas/_shared/envelope-success.json"
},
{
"type": "object",
"properties": {
"api_result": {
"type": "object",
"additionalProperties": true
}
}
}
]
}Fragment: main-app://schemas/_shared/envelope-success.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/_shared/envelope-success.json",
"title": "Canonical success envelope",
"type": "object",
"required": ["api_code", "api_result"],
"properties": {
"api_code": { "const": 200 },
"api_result": true,
"empty": { "type": "boolean" }
},
"additionalProperties": false
}Did this page help?