TriggersResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"triggers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerObject"
}
},
"next_page": {
"type": "string",
"nullable": true
},
"previous_page": {
"type": "string",
"nullable": true
}
}
}
TwitterChannelObject
{
"type": "object",
"title": "Monitored X handles",
"example": {
"id": 211,
"created_at": "2009-05-13T00:07:08Z",
"updated_at": "2011-07-22T00:11:12Z",
"screen_name": "@zendesk",
"twitter_user_id": 67462376832
},
"required": [
"id",
"screen_name",
"twitter_user_id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned upon creation"
},
"name": {
"type": "string",
"readOnly": true,
"description": "The profile name of the handle"
},
"brand_id": {
"type": "integer",
"readOnly": true,
"description": "What brand the handle is associated with"
},
"can_reply": {
"type": "boolean",
"readOnly": true,
"description": "If replies are allowed for this handle"
},
"avatar_url": {
"type": "string",
"readOnly": true,
"description": "The profile image url of the handle"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the handle was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time of the last update of the handle"
},
"allow_reply": {
"type": "boolean",
"readOnly": true,
"description": "If replies are allowed for this handle"
},
"screen_name": {
"type": "string",
"readOnly": true,
"description": "The X handle"
},
"twitter_user_id": {
"type": "integer",
"readOnly": true,
"description": "The country's code"
}
}
}
TwitterChannelResponse
{
"type": "object",
"properties": {
"monitored_twitter_handle": {
"$ref": "#/components/schemas/TwitterChannelObject"
}
}
}
TwitterChannelTwicketStatusResponse
{
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"favorited": {
"type": "boolean"
},
"retweeted": {
"type": "boolean"
},
"user_followed": {
"type": "boolean"
}
}
}
}
}
}
TwitterChannelsResponse
{
"type": "object",
"properties": {
"monitored_twitter_handles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwitterChannelObject"
}
}
}
}
UpdateResourceResult
{
"type": "object",
"required": [
"id",
"action",
"success",
"status"
],
"properties": {
"id": {
"type": "integer",
"description": "the id of the resource the job attempted to update"
},
"action": {
"type": "string",
"description": "the action the job attempted (`\"action\": \"update\"`)\n"
},
"status": {
"type": "string",
"description": "the status (`\"status\": \"Updated\"`)\n"
},
"success": {
"type": "boolean",
"description": "whether the action was successful or not (`\"success\": true`)\n"
}
}
}
UrlObject
{
"type": "object",
"properties": {
"url": {
"type": "string",
"readOnly": true
}
}
}
UserCreateInput
{
"type": "object",
"required": [
"name",
"email"
],
"properties": {
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"email": {
"type": "string"
},
"identities": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"external_id": {
"type": "string"
},
"organization": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
},
"custom_role_id": {
"type": "integer"
},
"organization_id": {
"type": "integer"
}
}
}
UserFieldResponse
{
"type": "object",
"properties": {
"user_field": {
"$ref": "#/components/schemas/CustomFieldObject"
}
}
}
UserFieldsReorderFieldResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
UserFieldsResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"readOnly": true,
"description": "Total count of records retrieved"
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "URL of the next page"
},
"user_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldObject"
}
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "URL of the previous page"
}
}
}
UserForAdmin
{
"type": "object",
"title": "Users",
"example": {
"id": 35436,
"url": "https://company.zendesk.com/api/v2/users/35436.json",
"name": "Johnny Agent",
"role": "agent",
"tags": [
"enterprise",
"other_tag"
],
"alias": "Mr. Johnny",
"email": "johnny@example.com",
"notes": "Johnny is a nice guy!",
"phone": "+15551234567",
"photo": {
"id": 928374,
"name": "my_funny_profile_pic.png",
"size": 166144,
"thumbnails": [
{
"id": 928375,
"name": "my_funny_profile_pic_thumb.png",
"size": 58298,
"content_url": "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",
"content_type": "image/png"
}
],
"content_url": "https://company.zendesk.com/photos/my_funny_profile_pic.png",
"content_type": "image/png"
},
"active": true,
"locale": "en-US",
"shared": false,
"details": "",
"verified": true,
"locale_id": 1,
"moderator": true,
"role_type": 0,
"signature": "Have a nice day, Johnny",
"suspended": true,
"time_zone": "Copenhagen",
"created_at": "2009-07-20T22:55:29Z",
"updated_at": "2011-05-05T10:38:52Z",
"external_id": "sai989sur98w9",
"user_fields": {
"user_date": "2012-07-23T00:00:00Z",
"user_decimal": 5.1,
"user_dropdown": "option_1"
},
"shared_agent": false,
"last_login_at": "2011-05-05T10:38:52Z",
"custom_role_id": 9373643,
"iana_time_zone": "Pacific/Pago_Pago",
"organization_id": 57542,
"restricted_agent": true,
"ticket_restriction": "assigned",
"only_private_comments": false
},
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when the user is created"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The user's API url"
},
"name": {
"type": "string",
"description": "The user's name"
},
"role": {
"type": "string",
"description": "The user's role. Possible values are \"end-user\", \"agent\", or \"admin\""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The user's tags. Only present if your account has user tagging enabled"
},
"alias": {
"type": "string",
"description": "An alias displayed to end users"
},
"email": {
"type": "string",
"description": "The user's primary email address. *Writeable on create only. On update, a secondary email is added. See [Email Address](https://developer.zendesk.com)"
},
"notes": {
"type": "string",
"description": "Any notes you want to store about the user"
},
"phone": {
"type": "string",
"nullable": true,
"description": "The user's primary phone number. See [Phone Number](https://developer.zendesk.com) below"
},
"photo": {
"type": "object",
"nullable": true,
"description": "The user's profile picture represented as an [Attachment](https://developer.zendesk.com) object",
"additionalProperties": true
},
"active": {
"type": "boolean",
"readOnly": true,
"description": "false if the user has been deleted"
},
"locale": {
"type": "string",
"description": "The user's locale. A BCP-47 compliant tag for the locale. If both \"locale\" and \"locale_id\" are present on create or update, \"locale_id\" is ignored and only \"locale\" is used."
},
"shared": {
"type": "boolean",
"readOnly": true,
"description": "If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only"
},
"details": {
"type": "string",
"description": "Any details you want to store about the user, such as an address"
},
"verified": {
"type": "boolean",
"description": "Any of the user's identities is verified. See [User Identities](https://developer.zendesk.com)"
},
"chat_only": {
"type": "boolean",
"readOnly": true,
"description": "Whether or not the user is a chat-only agent"
},
"locale_id": {
"type": "integer",
"description": "The user's language identifier"
},
"moderator": {
"type": "boolean",
"description": "Designates whether the user has forum moderation capabilities"
},
"role_type": {
"type": "integer",
"nullable": true,
"readOnly": true,
"description": "The user's role id. 0 for a custom agent, 1 for a light agent, 2 for a chat agent, 3 for a chat agent added to the Support account as a contributor ([Chat Phase 4](https://support.zendesk.com/hc/en-us/articles/360022365373#topic_djh_1zk_4fb)), 4 for an admin, and 5 for a billing admin"
},
"signature": {
"type": "string",
"description": "The user's signature. Only agents and admins can have signatures"
},
"suspended": {
"type": "boolean",
"description": "If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal"
},
"time_zone": {
"type": "string",
"description": "The user's time zone. See [Time Zone](https://developer.zendesk.com)"
},
"created_at": {
"type": "string",
"format": "datetime",
"readOnly": true,
"description": "The time the user was created"
},
"report_csv": {
"type": "boolean",
"readOnly": true,
"description": "This parameter is inert and has no effect. It may be deprecated in the\nfuture.\n\nPreviously, this parameter determined whether a user could access a CSV\nreport in a legacy Guide dashboard. This dashboard has been removed. See\n[Announcing Guide legacy reporting upgrade to\nExplore](https://support.zendesk.com/hc/en-us/articles/4762263171610-Announcing-Guide-legacy-reporting-upgrade-to-Explore-)\n"
},
"updated_at": {
"type": "string",
"format": "datetime",
"readOnly": true,
"description": "The time the user was last updated"
},
"external_id": {
"type": "string",
"nullable": true,
"description": "A unique identifier from another system. The API treats the id as case insensitive. Example: \"ian1\" and \"IAN1\" are the same value."
},
"user_fields": {
"type": "object",
"description": "Values of custom fields in the user's profile. See [User Fields](https://developer.zendesk.com)",
"additionalProperties": true
},
"shared_agent": {
"type": "boolean",
"readOnly": true,
"description": "If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only"
},
"last_login_at": {
"type": "string",
"format": "datetime",
"readOnly": true,
"description": "Last time the user signed in to Zendesk Support or made an API request\nusing an API token or basic authentication\n"
},
"custom_role_id": {
"type": "integer",
"nullable": true,
"description": "A custom role if the user is an agent on the Enterprise plan or above"
},
"iana_time_zone": {
"type": "string",
"readOnly": true,
"description": "The time zone for the user"
},
"organization_id": {
"type": "integer",
"nullable": true,
"description": "The id of the user's organization. If the user has more than one [organization memberships](https://developer.zendesk.com), the id of the user's default organization. If updating, see [Organization ID](https://developer.zendesk.com)"
},
"default_group_id": {
"type": "integer",
"description": "The id of the user's default group"
},
"remote_photo_url": {
"type": "string",
"description": "A URL pointing to the user's profile picture."
},
"restricted_agent": {
"type": "boolean",
"description": "If the agent has any restrictions; false for admins and unrestricted agents, true for other agents"
},
"ticket_restriction": {
"type": "string",
"nullable": true,
"description": "Specifies which tickets the user has access to. Possible values are: \"organization\", \"groups\", \"assigned\", \"requested\", null. \"groups\" and \"assigned\" are valid only for agents. If you pass an invalid value to an end user (for example, \"groups\"), they will be assigned to \"requested\", regardless of their previous access"
},
"shared_phone_number": {
"type": "boolean",
"nullable": true,
"description": "Whether the `phone` number is shared or not. See [Phone Number](https://developer.zendesk.com) below"
},
"only_private_comments": {
"type": "boolean",
"description": "true if the user can only create private comments"
},
"two_factor_auth_enabled": {
"type": "boolean",
"nullable": true,
"readOnly": true,
"description": "If two factor authentication is enabled"
}
}
}
UserForEndUser
{
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when creating users"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of this user"
},
"name": {
"type": "string",
"description": "The name of the user"
},
"role": {
"type": "string",
"description": "The role of the user. Possible values: `\"end-user\"`, `\"agent\"`, `\"admin\"`"
},
"email": {
"type": "string",
"description": "The primary email address of this user. If the primary email address is not [verified](https://support.zendesk.com/hc/en-us/articles/4408886752410), the secondary email address is used"
},
"phone": {
"type": "string",
"description": "The primary phone number of this user. See [Phone Number](/api-reference/ticketing/users/users/#phone-number) in the Users API"
},
"photo": {
"type": "object",
"description": "The user's profile picture represented as an [Attachment](https://developer.zendesk.com) object",
"additionalProperties": true
},
"locale": {
"type": "string",
"readOnly": true,
"description": "The locale for this user"
},
"verified": {
"type": "boolean",
"description": "Any of the user's identities is verified. See [User Identities](https://developer.zendesk.com)"
},
"locale_id": {
"type": "integer",
"description": "The language identifier for this user"
},
"time_zone": {
"type": "string",
"description": "The time-zone of this user"
},
"created_at": {
"type": "string",
"format": "datetime",
"readOnly": true,
"description": "The time the user was created"
},
"updated_at": {
"type": "string",
"format": "datetime",
"readOnly": true,
"description": "The time of the last update of the user"
},
"iana_time_zone": {
"type": "string",
"readOnly": true,
"description": "The time zone for the user"
},
"organization_id": {
"type": "integer",
"description": "The id of the user's organization. If the user has more than one [organization memberships](https://developer.zendesk.com), the id of the user's default organization. If updating, see [Organization ID](/api-reference/ticketing/users/users/#organization-id)"
},
"shared_phone_number": {
"type": "boolean",
"description": "Whether the `phone` number is shared or not. See [Phone Number](/api-reference/ticketing/users/users/#phone-number) in the Users API"
}
}
}
UserIdentitiesRequestVerificationEmailResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
UserIdentitiesResponse
{
"type": "object",
"properties": {
"identities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserIdentityObject"
}
}
}
}
UserIdentityObject
{
"type": "object",
"example": {
"id": 35436,
"url": "https://company.zendesk.com/api/v2/users/135/identities/35436.json",
"type": "email",
"value": "someone@example.com",
"primary": true,
"user_id": 135,
"verified": true,
"created_at": "2011-07-20T22:55:29Z",
"updated_at": "2011-07-20T22:55:29Z",
"deliverable_state": "deliverable"
},
"required": [
"user_id",
"type",
"value"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned on creation"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of this identity"
},
"type": {
"enum": [
"email",
"twitter",
"facebook",
"google",
"phone_number",
"agent_forwarding",
"any_channel",
"foreign",
"sdk"
],
"type": "string",
"readOnly": true,
"description": "The type of this identity"
},
"value": {
"type": "string",
"readOnly": true,
"description": "The identifier for this identity, such as an email address"
},
"primary": {
"type": "boolean",
"description": "If the identity is the primary identity. *Writable only when creating, not when updating. Use the [Make Identity Primary](https://developer.zendesk.com) endpoint instead"
},
"user_id": {
"type": "integer",
"readOnly": true,
"description": "The id of the user"
},
"verified": {
"type": "boolean",
"description": "If the identity has been verified"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the identity was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the identity was updated"
},
"deliverable_state": {
"type": "string",
"readOnly": true,
"description": "Email identity type only. Indicates if Zendesk sends notifications to the email address. See [Deliverable state](https://developer.zendesk.com)"
},
"undeliverable_count": {
"type": "integer",
"readOnly": true,
"description": "The number of times a soft-bounce response was received at that address"
}
}
}
UserIdentityResponse
{
"type": "object",
"properties": {
"identity": {
"$ref": "#/components/schemas/UserIdentityObject"
}
}
}
UserInput
{
"anyOf": [
{
"$ref": "#/components/schemas/UserCreateInput"
},
{
"$ref": "#/components/schemas/UserMergePropertiesInput"
},
{
"$ref": "#/components/schemas/UserMergeByIdInput"
}
],
"additionalProperties": true
}
UserMergeByIdInput
{
"type": "object",
"properties": {
"id": {
"type": "integer"
}
}
}
UserMergePropertiesInput
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"organization_id": {
"type": "integer"
}
}
}
UserObject
{
"anyOf": [
{
"$ref": "#/components/schemas/UserForAdmin"
},
{
"$ref": "#/components/schemas/UserForEndUser"
}
],
"additionalProperties": true
}
UserPasswordRequirementsResponse
{
"type": "object",
"properties": {
"requirements": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
UserPasswordsChangePasswordResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
UserPasswordsSetNewPasswordResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
UserRelatedObject
{
"type": "object",
"properties": {
"ccd_tickets": {
"type": "integer",
"description": "Count of collaborated tickets"
},
"assigned_tickets": {
"type": "integer",
"description": "Count of assigned tickets"
},
"requested_tickets": {
"type": "integer",
"description": "Count of requested tickets"
},
"organization_subscriptions": {
"type": "integer",
"description": "Count of organization subscriptions"
}
}
}
UserRelatedResponse
{
"type": "object",
"properties": {
"user_related": {
"$ref": "#/components/schemas/UserRelatedObject"
}
}
}
UserRequest
{
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/UserInput"
}
}
}
UserResponse
{
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/UserObject"
}
}
}
UsersLogoutManyUsersResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
UsersRequest
{
"type": "object",
"required": [
"users"
],
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserInput"
}
}
}
}
UsersRequestCreateReminderResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
UsersResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserObject"
}
}
}
}
UsersUpdateManyRequest
{
"oneOf": [
{
"$ref": "#/components/schemas/UserRequest"
},
{
"$ref": "#/components/schemas/UsersRequest"
}
],
"additionalProperties": true
}
ViaObject
{
"type": "object",
"example": {
"source": {
"to": {},
"rel": "trigger",
"from": {
"id": 22472716,
"title": "Assign to first responder"
}
},
"channel": "rule"
},
"readOnly": true,
"properties": {
"source": {
"type": "object",
"properties": {
"to": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"type": "string"
}
}
},
"rel": {
"type": "string",
"nullable": true
},
"from": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"address": {
"type": "string",
"nullable": true
}
}
}
},
"description": "For some channels a source object gives more information about how or why the ticket or event was created\n",
"additionalProperties": true
},
"channel": {
"type": "string",
"description": "This tells you how the ticket or event was created. Examples: \"web\", \"mobile\", \"rule\", \"system\"\n"
}
},
"description": "An object explaining how the ticket was created. See the [Via object reference](https://developer.zendesk.com)\n"
}
ViewCountObject
{
"type": "object",
"properties": {
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of the count"
},
"fresh": {
"type": "boolean",
"readOnly": true,
"description": "false if the cached data is stale and the system is still loading and caching new data"
},
"value": {
"type": "integer",
"nullable": true,
"readOnly": true,
"description": "The cached number of tickets in the view. Can also be null if the system is loading and caching new data. Not to be confused with 0 tickets"
},
"active": {
"type": "boolean",
"readOnly": true,
"description": "Only active views if true, inactive views if false, all views if null."
},
"pretty": {
"type": "string",
"readOnly": true,
"description": "A pretty-printed text approximation of the view count"
},
"view_id": {
"type": "integer",
"readOnly": true,
"description": "The id of the view"
}
}
}
ViewCountResponse
{
"type": "object",
"properties": {
"view_count": {
"$ref": "#/components/schemas/ViewCountObject"
}
}
}
ViewCountsResponse
{
"type": "object",
"properties": {
"view_counts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ViewCountObject"
}
}
}
}
ViewExportResponse
{
"type": "object",
"properties": {
"export": {
"type": "object",
"properties": {
"status": {
"type": "string",
"readOnly": true
},
"view_id": {
"type": "integer",
"readOnly": true
}
}
}
}
}
ViewObject
{
"type": "object",
"example": {
"id": 25,
"title": "Tickets updated <12 Hours",
"active": true,
"default": false,
"position": 8,
"execution": {
"sort": {
"id": "updatedX",
"order": "desc",
"title": "Updated"
},
"group": {
"id": "statusX",
"order": "desc",
"title": "Status"
},
"columns": [
{
"id": "status",
"title": "Status"
},
{
"id": "updated",
"title": "Updated"
},
{
"id": 5,
"url": "https://example.zendesk.com/api/v2/ticket_fields/5.json",
"type": "text",
"title": "Account"
}
]
},
"conditions": {
"all": [
{
"field": "status",
"value": "solved",
"operator": "less_than"
},
{
"field": "assignee_id",
"value": "296220096",
"operator": "is"
}
],
"any": []
},
"description": "View for recent tickets",
"restriction": {
"id": 4,
"type": "User"
}
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when created"
},
"title": {
"type": "string",
"description": "The title of the view"
},
"active": {
"type": "boolean",
"description": "Whether the view is active"
},
"default": {
"type": "boolean",
"readOnly": true,
"description": "If true, the view is a default view"
},
"position": {
"type": "integer",
"description": "The position of the view"
},
"execution": {
"type": "object",
"description": "Describes how the view should be executed. See [Execution](https://developer.zendesk.com)",
"additionalProperties": true
},
"conditions": {
"type": "object",
"description": "Describes how the view is constructed. See [Conditions reference](https://developer.zendesk.com)",
"additionalProperties": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the view was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the view was last updated"
},
"description": {
"type": "string",
"description": "The description of the view"
},
"restriction": {
"type": "object",
"description": "Who may access this account. Is null when everyone in the account can access it",
"additionalProperties": true
}
}
}
ViewResponse
{
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"view": {
"$ref": "#/components/schemas/ViewObject"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"columns": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
}
}
ViewsCountResponse
{
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"value": {
"type": "integer"
},
"refreshed_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
ViewsResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"readOnly": true
},
"views": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ViewObject"
}
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true
}
}
}
WorkspaceInput
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the workspace"
},
"macros": {
"type": "array",
"items": {
"type": "number"
}
},
"conditions": {
"$ref": "#/components/schemas/ConditionsObject"
},
"description": {
"type": "string",
"description": "User-defined description of this workspace's purpose"
},
"ticket_form_id": {
"type": "number"
}
}
}
WorkspaceObject
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Automatically assigned upon creation"
},
"url": {
"type": "string",
"description": "The URL for this resource"
},
"apps": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "The apps associated to this workspace"
},
"title": {
"type": "string",
"description": "The title of the workspace"
},
"macros": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of the macros associated to this workspace"
},
"position": {
"type": "integer",
"description": "Ordering of the workspace relative to other workspaces"
},
"activated": {
"type": "boolean",
"description": "If true, this workspace is available for use"
},
"macro_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of the macros associated to this workspace"
},
"conditions": {
"$ref": "#/components/schemas/ConditionsObject"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The time the workspace was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The time of the last update of the workspace"
},
"description": {
"type": "string",
"description": "User-defined description of this workspace's purpose"
},
"ticket_form_id": {
"type": "integer",
"description": "The id of the ticket web form associated to this workspace"
},
"selected_macros": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MacroObject"
},
"description": "An array of the macro objects that will be used in this workspace. See [Macros](https://developer.zendesk.com)"
},
"prefer_workspace_app_order": {
"type": "boolean",
"description": "If true, the order of apps within the workspace will be preserved"
}
}
}
WorkspaceResponse
{
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"workspaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkspaceObject"
}
}
}
},
{
"$ref": "#/components/schemas/OffsetPaginationObject"
}
]
}
WorkspacesBulkDeleteResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
WorkspacesCreateNewRequest
{
"type": "object",
"properties": {
"workspace": {
"$ref": "#/components/schemas/WorkspaceInput"
}
}
}
WorkspacesCreateNewResponse
{
"type": "object",
"properties": {
"workspace": {
"$ref": "#/components/schemas/WorkspaceObject"
}
}
}
WorkspacesGetWorkspaceResponse
{
"type": "object",
"properties": {
"workspace": {
"$ref": "#/components/schemas/WorkspaceObject"
}
}
}
WorkspacesReorderWorkspacesRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "number"
}
}
}
}