Access Token

Refresh Token

Subdomain

Zendesk

Articles

Organizations

Permission Groups

Sections

Ticket Comments

POST requests only. Users to add as cc's when creating a ticket. See Setting Collaborators

Tickets

User Segments

Whether or not the user is a chat-only agent

A custom role if the user is an agent on the Enterprise plan or above

Any details you want to store about the user, such as an address

The user's primary email address. *Writeable on create only. On update, a secondary email is added. See Email Address

A unique identifier from another system. The API treats the id as case insensitive. Example: "ian1" and "IAN1" are the same value.

Automatically assigned when the user is created

Last time the user signed in to Zendesk Support or made an API request using an API token or basic authentication

Designates whether the user has forum moderation capabilities

Any notes you want to store about the user

true if the user can only create private comments

The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization. If updating, see Organization ID

The user's primary phone number. See Phone Number below

The user's profile picture represented as an Attachment object

A URL pointing to the user's profile picture.

This parameter is inert and has no effect. It may be deprecated in the future. Previously, this parameter determined whether a user could access a CSV report in a legacy Guide dashboard. This dashboard has been removed. See Announcing Guide legacy reporting upgrade to Explore

If the agent has any restrictions; false for admins and unrestricted agents, true for other agents

The user's role. Possible values are "end-user", "agent", or "admin"

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), 4 for an admin, and 5 for a billing admin

If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only

If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only

Whether the phone number is shared or not. See Phone Number below

The user's signature. Only agents and admins can have signatures

If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal

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

Values of custom fields in the user's profile. See User Fields

Any of the user's identities is verified. See User Identities

User Fields

Users

You can also add tags to multiple tickets with the [Update Many
Tickets](/api-reference/ticketing/tickets/tickets/#update-many-tickets) endpoint.

#### Safe Update

If the same ticket is updated by multiple API requests at
the same time, some tags could be lost because of ticket
update collisions. Include `updated_stamp` and `safe_update`
properties in the request body to make a safe update.

For `updated_stamp`, retrieve and specify the ticket's
latest `updated_at` timestamp. The tag update only occurs
if the `updated_stamp` timestamp matches the ticket's
actual `updated_at` timestamp at the time of the request.
If the timestamps don't match (in other words, if the
ticket was updated since you retrieved the ticket's
last `updated_at` timestamp), the request returns a
409 Conflict error.

#### Example

```js
{
  "tags": ["customer"],
  "updated_stamp":"2019-09-12T21:45:16Z",
  "safe_update":"true"
}
```

For details, see [Protecting against ticket update collisions](/api-reference/ticketing/tickets/tickets/#protecting-against-ticket-update-collisions).

#### Allowed For

* Agents


Add Tags

Returns an array of organizations whose name starts with the
value specified in the `name` parameter.

#### Pagination

* Offset pagination only

See [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).

#### Allowed For

* Agents


Autocomplete Organizations

Returns tickets whose type is "problem" and whose subject contains the string specified in the `text` parameter.

You can specify the `text` parameter in the request body rather than the query string. Example:

`{"text": "fire"}`

#### Allowed For

* Agents

Autocomplete Problems

Returns an array of users whose name starts with the value specified in the `name` parameter.
It only returns users with no foreign identities.

#### Allowed For

* Agents


Autocomplete Users

Assigns up to 100 agents to given groups.

#### Allowed For

* Admins

#### Response

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work. Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.


Bulk Create Memberships

Deletes the automations corresponding to the provided comma-separated list of IDs.

**Note**: You might be restricted from deleting some default automations. If included in a bulk deletion, the unrestricted automations will be deleted.

#### Allowed For

* Agents

#### Request Parameters

The DELETE request takes one parameter, an `ids` object that lists the automations to delete.

| Name | Description
| ---- | -----------
| ids  | The IDs of the automations to delete

#### Example request

```js
{
  "ids": "25,23,27,22"
}
```


Bulk Delete Automations

Deletes the macros corresponding to the provided comma-separated list of IDs.

#### Allowed For
* Agents


Bulk Delete Macros

Accepts a comma-separated list of up to 100 organization ids or external ids.

#### Response

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.
Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.

#### Allowed For

* Admins


Bulk Delete Organizations

Deletes all the sessions for a user.

#### Allowed For

* Admins, Agents, End users


Bulk Delete Sessions

Accepts a comma-separated list of up to 100 ticket ids.

#### Allowed For

* Admins
* Agents with permission to delete tickets

Agent delete permissions are set in Support. See
[Deleting tickets](https://support.zendesk.com/hc/en-us/articles/203690936)
in the Support Help Center.

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work. Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion

Bulk Delete Tickets

Deletes the triggers corresponding to the provided comma-separated list of IDs.

#### Allowed For

* Agents

#### Request Parameters

The DELETE request takes one parameter, an `ids` object that lists the
triggers to delete.

| Name | Description
| ---- | -----------
| ids  | The IDs of the triggers to delete

#### Example request

```js
{
  "ids": "25,23,27,22"
}
```


Bulk Delete Triggers

Accepts a comma-separated list of up to 100 user ids.

The request takes an `ids` or an `external_ids` query parameter.

#### Allowed for

- Admins

#### Response

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.
Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.


Bulk Delete Users

Deletes the views corresponding to the provided list of IDs.

#### Allowed For
* Agents


Bulk Delete Views

Bulk Delete Workspaces

Accepts a comma-separated list of up to 100 ticket ids.

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.
Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion

#### Allowed For

* Agents

Bulk Mark Tickets as Spam

Unregisters the mobile devices that are receiving push notifications. Specify the devices as an array of mobile device tokens.

#### Allowed for

* Admins

Bulk Unregister Push Notification Devices

Updates the default values for many custom ticket statuses at once.

#### Allowed For

* Admins


Bulk Update Default Custom Ticket Status

Change a comment from public to private

You can only change your own password. Nobody can change the password of another user because it requires knowing the user's existing password. However, an admin can set a new password for another user without knowing the existing password. See [Set a User's Password](#set-a-users-password) above.

#### Allowed For

* Agents
* End Users


Change Your Password

Returns a JSON object determining whether a host mapping is valid for the given brand.

#### Allowed for
- Admins

Check Host Mapping Validity for an Existing Brand

Returns a JSON object determining whether a host mapping is valid for a given subdomain.

#### Allowed for

* Admins

Check Host Mapping Validity

Clone an already existing ticket form

Returns an approximate count of ticket activities in the last 30 days affecting the agent making the request. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours.

The `count[refreshed_at]` property is a timestamp that indicates when the count was last updated.

**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.
This indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is complete.

#### Allowed For
* Agents

Count Activities

Returns an approximate count of audits for a specified ticket. If the count exceeds 100,000, the count will return a cached result.  This cached result will update every 24 hours.

The `count[refreshed_at]` property is a timestamp that indicates when the count was last updated.

**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.
This indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is complete.

#### Allowed for

* Agents


Count Audits for a Ticket

Returns an approximate count of deleted users, including permanently deleted users. If the count exceeds 100,000, it is updated every 24 hours.

The response includes a `refreshed_at` property in a `count` object that contains a timestamp indicating when the count was last updated.

**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.
This indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is complete.

#### Allowed For

* Agents


Count Deleted Users

Returns an approximate count of groups. If the count exceeds 100,000, it is updated every 24 hours.

The `refreshed_at` property of the `count` object is a timestamp that indicates when the count was last updated.

**Note**: When the count exceeds 100,000, `refreshed_at` may occasionally be null. This indicates that the count is being updated in the background, and the `value` property of the `count` object is limited to 100,000 until the update is complete.

#### Allowed For

* Admins
* Agents


Count Groups

Returns an approximate count of organizations. If the count exceeds
100,000, it is updated every 24 hours.

The `refreshed_at` property of the `count` object is a timestamp that indicates
when the count was last updated.

When the count exceeds 100,000, the `refreshed_at` property may
occasionally be null. This indicates that the count is being
updated in the background and the `value` property of the `count` object is limited to
100,000 until the update is complete.

#### Allowed For

* Agents


Count Organizations

Returns an approximate count of satisfaction ratings in the account. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours.

The `count[refreshed_at]` property is a timestamp that indicates when the count was last updated.

**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.
This indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is complete.

#### Allowed For
* Agents

Count Satisfaction Ratings

Returns an approximate count of tags. If the count exceeds 100,000, it
is updated every 24 hours.

The `refreshed_at` property of the `count` object is a timestamp that indicates when
the count was last updated.

**Note**: When the count exceeds 100,000, the `refreshed_at` property in the `count` object may
occasionally be null. This indicates that the count is being
updated in the background and the `value` property in the `count` object is limited to
100,000 until the update is complete.

#### Allowed For

* Admins


Count Tags

Returns an approximate count of the comments added to the ticket. If the count exceeds 100,000, the count will return a cached result.  This cached result will update every 24 hours.

The `count[refreshed_at]` property is a timestamp that indicates when the count was last updated.

**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.
This indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is complete.

#### Allowed For
* Agents

Count Ticket Comments

Returns an approximate count of system and custom ticket fields in the account. If the count exceeds 100,000, the count will return a cached result.  This cached result will update every 24 hours.

The `count[refreshed_at]` property is a timestamp that indicates when the count was last updated.

**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.
This indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is complete.

#### Allowed For
* Agents

Count Ticket Fields

Returns the ticket count for a single view.

This endpoint is rate limited to 5 requests per minute, per view, per agent.

#### View Counts

The view count endpoints, Count Tickets in View (this endpoint) and [Count Tickets in Views](#count-tickets-in-views), let you estimate how many tickets remain in a view without having to retrieve the entire view. They're designed to help estimate view size. From a business perspective, accuracy becomes less relevant as view size increases.

To ensure quality of service, these counts are cached more heavily as the number of tickets in a view grows. For a view with thousands of tickets, you can expect the count to be cached for 60-90 minutes. As a result, the count may not reflect the actual number of tickets in your view.

View counts are represented as JSON objects with the following attributes:

| Name            | Type        | Comment
| --------------- | ------------| -------
| view_id         | integer     | The id of the view
| url             | string      | The API url of the count
| value           | integer     | 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
| pretty          | string      | A pretty-printed text approximation of the view count
| fresh           | boolean     | false if the cached data is stale and the system is still loading and caching new data
| active          | boolean     | Only active views if true, inactive views if false, all views if null.

#### Example
```js
{
  "view_count": {
    "view_id": 25,
    "url":     "https://company.zendesk.com/api/v2/views/25/count.json",
    "value":   719,
    "pretty":  "~700",
    "fresh":   true
  }
}
```


Count Tickets in View

Returns the ticket count of each view in a list of views. Accepts up to 20 view ids per request. For the ticket count of a single view, see [Count Tickets in View](#count-tickets-in-view).

Only returns values for personal and shared views accessible to the user performing the request.

This endpoint is rate limited to 6 requests every 5 minutes.

#### Allowed For

* Agents


Count Tickets in Views

Returns an approximate count of tickets in the account. If the count exceeds 100,000, it is updated every 24 hours.

`ccd` lists tickets that the specified user is cc'd on.

The `count[refreshed_at]` property is a timestamp that indicates when the count was last updated.

**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.
This indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is complete.

#### Allowed For
* Agents

Count Tickets

Returns an approximate count of users. If the count exceeds 100,000, it is updated every 24 hours.

The response includes a `refreshed_at` property in a `count` object that contains a timestamp indicating when the count was last updated.

**Note**: When the count exceeds 100,000, the `refreshed_at` property may occasionally be null.
This indicates that the count is being updated in the background. The `count` object's `value` property is limited to 100,000 until the update is complete.

#### Allowed For

* Admins, Agents and Light Agents


Count Users

Returns an approximate count of shared and personal views available to the current user. If the count exceeds 100,000, the count will return a cached result.  This cached result will update every 24 hours.

The `count[refreshed_at]` property is a timestamp that indicates when the count was last updated.

**Note**: When the count exceeds 100,000, `count[refreshed_at]` may occasionally be null.
This indicates that the count is being updated in the background, and `count[value]` is limited to 100,000 until the update is complete.

#### Allowed For
* Agents

Count Views

Creates a CSAT rating for a solved ticket, or for a ticket that was previously
solved and then reopened.

Only the end user listed as the ticket requester can create a satisfaction rating for the ticket.

#### Allowed For

* End user who requested the ticket

The end user must be a verified user.


Create a Satisfaction Rating

Creates an attribute value.

#### Allowed For

* Admins


Create Attribute Value

Creates an attribute.

#### Allowed For

* Agents


Create Attribute

Creates an automation.

New automations must be unique and have at least one condition that is true only once or an action that nullifies at least one of the conditions. Active automations can have overlapping conditions but can't be identical.

The request must include the following conditions in the `all` array:

- At least one time-based condition
- At least one condition that checks one of the following fields: `status`, `type`, `group_id`, `assignee_id`, or `requester_id`.

#### Allowed For

* Agents


Create Automation

Creates a job that performs a batch operation for the given trigger categories.

Create Batch Job for Trigger Categories

Create Bookmark

Create Brand

#### Availability

* Accounts on the Enterprise plan or above

#### Allowed For

* Administrators


Create Custom Role

Takes a `custom_status` object that specifies the custom ticket status properties to create.

#### Allowed For

* Admins


Create Custom Ticket Status

Create Group

Adds an identity to a user's profile. An agent can add an identity to any user profile.

Supported identity types:

| Type             | Example |
| ---------------- | ------- |
| email            | `{ "type" : "email", "value" : "someone@example.com" }` |
| twitter          | `{ "type" : "twitter", "value" : "screen_name" }` |
| facebook         | `{ "type" : "facebook", "value" : "855769377321" }` |
| google           | `{ "type" : "google", "value" : "example@gmail.com" }` |
| agent_forwarding | `{ "type" : "agent_forwarding", "value" : "+1 555-123-4567" }` |
| phone_number     | `{ "type" : "phone_number", "value" : "+1 555-123-4567" }` |

To create an identity without sending out a verification email, include a `"skip_verify_email": true` property.

#### Allowed For

* Agents


Create Identity

Create a new content item, with one or more variants in the item's `variants` array. See [Specifying item variants](#specifying-item-variants).

The `default_locale_id` and variant `locale_id` values must be one of the locales the account has active. You can get the list with the [List Locales](/api-reference/ticketing/account-configuration/locales/#list-locales) endpoint.

#### Allowed For

* Admins, Agents


Create Item

Allows an attachment to be uploaded and associated with a macro at the same time.

**Note:** A macro can be associated with up to five attachments.

#### Allowed For

* Agents


Create Macro Attachment

Create Macro

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work. Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.

#### Allowed For
* Admins
* Agents


Create Many Memberships

Accepts an array of up to 100 organization objects.

#### Response

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format)
and queues a background job to do the work. Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status)
endpoint to check for the job's completion.

#### Allowed For

* Agents, with restrictions applying on certain actions


Create Many Organizations

Accepts an array of up to 100 ticket objects. **Note**: Every ticket created with this endpoint may be affected by your business rules, which can include sending email notifications to your end users. If you are importing historical tickets or creating more than 1000 tickets, consider using the [Ticket Bulk Import](/api-reference/ticketing/tickets/ticket_import/#ticket-bulk-import) endpoint.

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work. Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.

#### Allowed For
* Agents

Create Many Tickets

Accepts an array of up to 100 user objects.

**Note**: Access to this endpoint is limited. You may not be able to use
it to bulk-import users or organizations. If you're unable, a 403 Forbidden
error is returned. If you need access and can't use this endpoint,
contact us at <a href="mailto:support@zendesk.com">support@zendesk.com</a>
for assistance.

#### Allowed For

* Agents, with restrictions on certain actions

#### Specifying an organization

You can assign a user to an existing organization by setting an
`organization_id` property in the user object.

#### Response

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.
Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.


Create Many Users

Create Many Variants

Create OLA Policy

Creates a new option or updates an existing option for the given drop-down user field.

To update an option, include the id of the option in the `custom_field_option` object. Example: `{"custom_field_option": {"id": 10002, "name": "Pineapples", ... }`. If an option exists for the given ID, the option will be updated. Otherwise, a new option will be created.

#### Response

Returns one of the following status codes:

- 200 with `Location: /api/v2/user_fields/{user_field_id}/options.json` if the user field option already exists in the database
- 201 with `Location: /api/v2/user_fields/{user_field_id}/options.json` if the user field option is new

#### Allowed For

* Admins


Create or Update a User Field Option

Accepts an array of up to 100 user objects. For each user, the user is created if it does not
already exist, or the existing user is updated.

Each individual user object can identify an existing user by `email` or by `external_id`.

This endpoint returns a `job_status` [JSON object](/api-reference/ticketing/ticket-management/job_statuses/#json-format) and queues a background job to do the work.
Use the [Show Job Status](/api-reference/ticketing/ticket-management/job_statuses/#show-job-status) endpoint to check for the job's completion.

#### Allowed For

* Agents, with restrictions on certain actions


Create Or Update Many Users

Creates an organization if it doesn't already exist, or updates
an existing organization. Using this method means one less call
to check if an organization exists before creating it. You need
to specify the id or external id when updating
an organization to avoid a duplicate error response. Name is
not available as a matching criteria.

#### Allowed For

* Agents, with restrictions on certain actions


Create Or Update Organization

Creates or updates an option for the given drop-down ticket field.

To update an option, include the id of the option in the `custom_field_option` object. Example:

`{"custom_field_option": {"id": 10002, "name": "Pineapples", ... }`

If an option exists for the given ID, the option will be updated. Otherwise, a new option will be created.

#### Response

Returns one of the following status codes:

- 200 with `Location: /api/v2/ticket_fields/{ticket_field_id}/options.json` if the ticket field option already exists in the database
- 201 with `Location: /api/v2/ticket_fields/{ticket_field_id}/options.json` if the ticket field option is new

#### Allowed For

* Admins

#### Rate Limit
You can make 100 requests every 1 minute using this endpoint.
The rate limiting mechanism behaves as described in
[Monitoring your request activity](/api-reference/ticketing/account-configuration/usage_limits/#monitoring-your-request-activity) in the API introduction.

#### Field Option Limits

* 2000 options per ticket field


Create or Update Ticket Field Option

Creates a user if the user does not already exist, or updates an existing user
identified by e-mail address or external ID.

If you don't specify a role parameter, the new user is assigned the role of end user.

If you need to create users without sending out a verification email, include a `"skip_verify_email": true` property in the body.

#### Response Status Code

- If the user exists in Zendesk, a successful request returns a 200 status code with "Location: /api/v2/users/{user_id}.json".
- If the user does not exist in Zendesk, a successful request returns a 201 status code with "Location: /api/v2/users/{new_user_id}.json".

#### Rate Limit

The rate limit is 5 requests per minute for each unique end user profile. For example, you can make 10 calls per second as long as you make five calls for one user and five calls for another user.
The rate limiting mechanism behaves as described in
[Usage Limits](/api-reference/introduction/rate-limits/#monitoring-your-request-activity)
in the API introduction. Zendesk recommends that you obey the Retry-After header values.

#### Allowed For

* Agents, with restrictions on certain actions


Create Or Update User

Creates any of the following custom field types:

* text (default when no "type" is specified)
* textarea
* checkbox
* date
* integer
* decimal
* regexp
* dropdown
* lookup

See [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in Zendesk help.

#### Allowed For

* Admins


Create Organization Field

#### Allowed For:

* Agents
* End users

End users can only subscribe to shared organizations in which they're members.

Create Organization Subscription

You must provide a unique `name` for each organization. Normally
the system doesn't allow records to be created with identical names.
However, a race condition can occur if you make two or more identical
POSTs very close to each other, causing the records to have identical
organization names.

#### Allowed For

* Admins


Create Organization

Accepts a `request` object that sets one or more properties.

#### Allowed for

* End users
* Anonymous users (rate limit of 5 requests per hour for [trial accounts](/documentation/developer-tools/getting-started/getting-a-trial-or-sponsored-account-for-development/))

#### Additional properties

In addition to the writable request properties in the [JSON Format table](#json-format) above, you can set the following properties when creating a request.

| Name                | Type   | Mandatory | Comment
| ----------------    | -------| --------- | -------
| comment             | object | yes       | Describes the problem, incident, question, or task. See [Request comments](#request-comments)
| collaborators       | array  | no        | Adds collaborators (cc's) to the request. An email notification is sent to them when the ticket is created. See [Setting collaborators](/documentation/ticketing/managing-tickets/creating-and-managing-requests#setting-collaborators)
| requester           | object | yes*      | \*Required for anonymous requests. Specifies the requester of the anonymous request. See [Creating anonymous requests](/documentation/ticketing/managing-tickets/creating-and-managing-requests#creating-anonymous-requests)

#### Creating follow-up requests

Once a ticket is closed (as distinct from solved), it can't be reopened. However, you can create a new request that references the closed ticket. To create the follow-up request, include a `via_followup_source_id` property in the `request` object that specifies the closed ticket. The parameter only works with closed tickets. It has no effect with other tickets.


Create Request

Creates a resource collection from a provided `payload` object. The `payload` object is specified the same way as the content of a requirements.json file in a Zendesk app. See [Specifying Apps Requirements](/documentation/apps/app-developer-guide/apps_requirements/) in the Zendesk Apps framework docs.

The response includes a [job
status](/api-reference/ticketing/ticket-management/job_statuses/) for creation of the specified resources.

#### Allowed for

* Admins


Create Resource Collection

Create Sharing Agreement

#### Availability

* Accounts on the Support Professional or Suite Growth plan or above

#### Allowed For

* Admins


Create SLA Policy

Adds a Zendesk or external support address to your account.

To add a Zendesk address, use the following syntax: `{local-part}@{accountname}.zendesk.com`.
Example: 'sales-team@example.zendesk.com'. The [local-part](https://en.wikipedia.org/wiki/Email_address#Local-part) can be anything you like.

To add an external email address such as help@omniwearshop.com, the email must already exist and you must set up forwarding on your email server. The exact steps depend on your mail server. See [Forwarding incoming email to Zendesk Support](https://support.zendesk.com/hc/en-us/articles/203663266). After setting up forwarding, run the [Verify Support Address Forwarding](#verify-support-address-forwarding) endpoint. The address won't work in Zendesk Support until it's been verified.

#### Allowed For

* Admins
* Agents with permission to manage channels and extensions. See the system permissions in [Creating custom roles and assigning agents (Enterprise)](https://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents-Enterprise-#topic_cxn_hig_bd) in the Support Help Center


Create Support Address

Create Target

Creates any of the following custom field types:

| Custom field type | Description                                                                                                                                                     |
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| text              | Default custom field type when `type` is not specified                                                                                                          |
| textarea          | For multi-line text                                                                                                                                             |
| checkbox          | To capture a boolean value. Allowed values are true or false                                                                                                    |
| date              | Example: 2021-04-16                                                                                                                                   |
| integer           | String composed of numbers. May contain an optional decimal point                                                                                               |
| decimal           | For numbers containing decimals                                                                                                                                 |
| regexp            | Matches the Regex pattern found in the custom field settings                                                                                                    |
| partialcreditcard | A credit card number. Only the last 4 digits are retained                                                                                                                                      |
| multiselect       | Enables users to choose multiple options from a dropdown menu                                                                                                |
| tagger            | Single-select dropdown menu. It contains one or more tag values belonging to the field's options. Example: ( {"id": 21938362, "value": ["hd_3000", "hd_5555"]}) |
| lookup            | A field to create a relationship (see [lookup relationships](/api-reference/ticketing/lookup_relationships/lookup_relationships/)) to another object such as a user, ticket, or organization |

See [About custom field types](https://support.zendesk.com/hc/en-us/articles/203661866) in the Zendesk Help Center.

#### Allowed For

* Admins

#### Field limits

We recommend the following best practices for ticket fields limits. Creating more than these amounts can affect performance.

* 400 ticket fields per account if your account doesn't have ticket forms
* 400 ticket fields per ticket form if your account has ticket forms


Create Ticket Field

Create Ticket Form

#### Allowed For
* Agents

### Creating tickets

#### Introduction

Creating tickets using Talk Partner Edition follows the same conventions as the Create Ticket endpoint. See [Create Ticket](/api-reference/ticketing/tickets/tickets/#create-ticket).

#### Request parameters

The POST request takes a mandatory `ticket` object that lists the values to set when the ticket is created.
You may also include an optional `display_to_agent` value such as the ID of the agent that will see the newly created ticket.

Tickets created using this endpoint must have a `via_id` parameter. See the following
section for possible values.

#### Zendesk Talk Integration Via IDs

Tickets created using this endpoint must have one of the following `via_id` parameters:

| ID       | Description
| ---------| -------------
| 44       | Voicemail
| 45       | Phone call (inbound)
| 46       | Phone call (outbound)

### Creating voicemail tickets
#### Request parameters

The POST request takes a mandatory `ticket` object that lists the values to set when the ticket is created.
The ticket must have a `voice_comment` with the following values:

| Name               | Type                  | Comment
| ------------------ | ----------------------| -------
| from               | string                | Incoming phone number
| to                 | string                | Dialed phone number
| recording_url      | string                | URL of the recording
| started_at         | date                  | [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) timestamp of the call starting time
| call_duration      | integer               | Duration in seconds of the call
| answered_by_id     | integer               | The agent who answered the call
| transcription_text | string                | Transcription of the call (optional)
| location           | string                | Location of the caller (optional)

Create Ticket or Voicemail Ticket

Create Ticket

Create Trial Account

Create Trigger Category

Create Trigger

Allows an attachment to be uploaded that can be associated with a macro at a later time.

**Note:** To ensure an uploaded attachment is not lost, associate it with a macro as soon as possible. From time to time, old attachments that are not not associated with any macro are purged.

#### Allowed For

* Agents


	List	Find by ID	Create	Update	Delete	Custom Fields
Organizations	✅	✅	✅	✅	✅	✅
Tickets	✅	✅	✅	✅	✅	✅
Users	✅	✅	✅	✅	✅	✅
Articles	✅	✅	✅	✅	✅	➖
Tags	✅	➖	➖	➖	✅	➖
Categories	✅	➖	➖	➖	➖	➖

	Companies automatically maps to	Tasks automatically maps to	Users automatically maps to
Freshdesk	Companies	Tickets	Agents
Salesforce	Accounts	Tasks	Users
Keap	Companies	Tasks	Users
HubSpot	Companies	Tasks	Owners
Salesloft	Accounts	Tasks	Users
Copper	Companies	Tasks	Users
MS Dynamics CRM	Accounts	Tasks	Systemusers
Zoho Books	Contacts	Tasks	Users
Capsule CRM	Organisations	Tasks	Users
Close	Lead	Task	User

Zendesk integration connector

Managed authentication

Execute Zendesk operations on behalf of your customers

Add Tags

Safe Update

Autocomplete Organizations

Autocomplete Problems

Autocomplete Users

Allowed For

Bulk Create Memberships

Allowed For

Response

Bulk Delete Automations

Work with Zendesk data collections

Trigger integrations on Zendesk events

Data Record Created

Data Record Updated

Data Record Deleted

Use the same code to integrate with Zendesk and 100+ other applications

Companies

Tasks

Users

Try our AI-powered integration development environment for free

Zendesk integration connector

Managed authentication

Execute Zendesk operations on behalf of your customersself.__wrap_n!=1&&self.__wrap_b(":Rat56:",1)

Add Tags

Safe Update

Autocomplete Organizations

Pagination

Autocomplete Problems

Autocomplete Users

Allowed For

Bulk Create Memberships

Allowed For

Response

Bulk Delete Automations

Work with Zendesk data collectionsself.__wrap_n!=1&&self.__wrap_b(":Rb556:",1)

Trigger integrations on Zendesk eventsself.__wrap_n!=1&&self.__wrap_b(":Rbd56:",1)

Data Record Created

Data Record Updated

Data Record Deleted

Use the same code to integrate with Zendesk and 100+ other applicationsself.__wrap_n!=1&&self.__wrap_b(":Rbl56:",1)

Companies

Tasks

Users

Try our AI-powered integration development environment for free

Execute Zendesk operations on behalf of your customers

Work with Zendesk data collections

Trigger integrations on Zendesk events

Use the same code to integrate with Zendesk and 100+ other applications