Zendesk (version v1.*.*)

organization_id (required)#

Organization ID

Type: number

$body#

Type: object

{
  "tags" : [ "string" ]
}

ticket_id (required)#

Ticket ID

Type: number

$body#

Type: object

{
  "tags" : [ "string" ]
}

user_id (required)#

User ID

Type: number

$body#

Type: object

{
  "tags" : [ "string" ]
}

name#

Type: string

sort_order#

Type: string

Potential values: desc, asc

text#

Type: string

name#

Type: string

name#

Type: string

sort_order#

Type: string

Potential values: desc, asc

host_mapping#

Type: string

subdomain#

Type: string

id (required)#

Brand ID

Type: number

ticket_form_id (required)#

Ticket Form ID

Type: number

$body#

Type: object

{
  "automation" : {
    "updated_at" : "The time of the last update of the automation",
    "active" : "Whether the automation is active",
    "created_at" : "The time the automation was created",
    "id" : "Automatically assigned when created",
    "position" : "Position of the automation, determines the order they will execute in",
    "title" : "The title of the automation",
    "conditions" : {
      "all" : [ {
        "field" : "The name of a ticket field",
        "value" : "The value of a ticket field",
        "operator" : "A comparison operator"
      } ],
      "any" : [ {
        "field" : "The name of a ticket field",
        "value" : "The value of a ticket field",
        "operator" : "A comparison operator"
      } ]
    },
    "actions" : {
      "actions" : [ {
        "field" : "The name of a field",
        "value" : "The value of the field"
      } ]
    }
  }
}

$body#

Type: object

{
  "bookmark" : {
    "ticket" : {
      "subject" : "The value of the subject field for this ticket",
      "email_cc_ids" : [ "number" ],
      "additional_tags" : [ "string" ],
      "description" : "The first comment on the ticket",
      "created_at" : "When this record was created",
      "external_id" : "An id you can use to link Zendesk Support tickets to local records",
      "macro_ids" : [ "number" ],
      "type" : "The type of this ticket.",
      "updated_stamp" : "If the updated_stamp property does not match the updated_at datetime value for the ticket the update operation will fail and an UpdateConflict error response will be sent.",
      "via" : {
        "channel" : "This tells you how the ticket or event was created.",
        "source" : {
          "rel" : "string",
          "from" : { },
          "to" : { }
        }
      },
      "allow_attachments" : "When an agent responds, are they allowed to add attachments? Defaults to true",
      "updated_at" : "When this record last got updated",
      "problem_id" : "For tickets of type \"incident\", the ID of the problem the incident is linked to",
      "follower_ids" : [ "number" ],
      "collaborators" : [ "number" ],
      "due_at" : "If this is a ticket of type \"task\" it has a due date. Due date format uses ISO 8601 format.",
      "id" : "Automatically assigned when the ticket is created",
      "assignee_id" : "The agent currently assigned to the ticket",
      "raw_subject" : "The dynamic content placeholder, if present, or the \"subject\" value, if not. See Dynamic Content",
      "safe_update" : "When the safe_update property has a value of true, the updated_stamp property is required, and only if the updated_at datetime value on the ticket matches the updated_stamp value will the ticket be updated.",
      "forum_topic_id" : "The topic this ticket originated from, if any",
      "custom_fields" : [ {
        "id" : "number",
        "value" : "string"
      } ],
      "allow_channelback" : "Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket",
      "satisfaction_rating" : { },
      "submitter_id" : "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket",
      "priority" : "The urgency with which the ticket should be addressed.",
      "collaborator_ids" : [ "number" ],
      "url" : "The API url of this ticket",
      "tags" : [ "string" ],
      "brand_id" : "Enterprise only. The id of the brand this ticket is associated with",
      "ticket_form_id" : "Enterprise only. The id of the ticket form to render for the ticket",
      "remove_tags" : [ "string" ],
      "sharing_agreement_ids" : [ "number" ],
      "group_id" : "The group this ticket is assigned to",
      "organization_id" : "The organization of the requester. You can only specify the ID of an organization associated with the requester. See Organization Memberships",
      "followup_ids" : [ "number" ],
      "recipient" : "The original recipient e-mail address of the ticket",
      "via_followup_source_id" : "POST requests only. The id of a closed ticket when creating a follow-up ticket. See Creating Follow-up Tickets",
      "is_public" : "Is true if any comments are public, false otherwise",
      "comment" : {
        "metadata" : { },
        "attachments" : [ {
          "content_type" : "The content type of the image.",
          "size" : "The size of the image file in bytes",
          "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
          "file_name" : "The name of the image file",
          "content_url" : "A full URL where the attachment image file can be downloaded",
          "id" : "Automatically assigned when created",
          "thumbnails" : [ { } ]
        } ],
        "public" : "true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it",
        "html_body" : "The comment formatted as HTML",
        "plain_body" : "The comment as plain text",
        "created_at" : "The time the comment was created",
        "id" : "Automatically assigned when the comment is created",
        "type" : "string. Possible values: Comment | VoiceComment",
        "body" : "The comment string",
        "author_id" : "The id of the comment author.",
        "via" : {
          "channel" : "This tells you how the ticket or event was created.",
          "source" : {
            "rel" : "string",
            "from" : { },
            "to" : { }
          }
        }
      },
      "has_incidents" : "Is true of this ticket has been marked as a problem, false otherwise",
      "status" : "The state of the ticket.",
      "requester_id" : "The user who requested this ticket"
    },
    "created_at" : "The time the bookmark was created",
    "id" : "Automatically assigned when the bookmark is created",
    "url" : "The API url of this bookmark"
  }
}

$body#

Type: object

{
  "brand" : {
    "ticket_form_ids" : [ "integer" ],
    "host_mapping" : "The hostmapping to this brand, if any (only admins view this key)",
    "active" : "If the brand is set as active",
    "created_at" : "The time the brand was created",
    "help_center_state" : "The state of the Help Center",
    "url" : "The API url of this brand",
    "brand_url" : "The url of the brand",
    "has_help_center" : "If the brand has a Help Center",
    "default" : "Is the brand the default brand for this account",
    "updated_at" : "The time of the last update of the brand",
    "signature_template" : "The signature template for a brand",
    "name" : "The name of the brand",
    "logo" : {
      "content_type" : "The content type of the image.",
      "size" : "The size of the image file in bytes",
      "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
      "file_name" : "The name of the image file",
      "content_url" : "A full URL where the attachment image file can be downloaded",
      "id" : "Automatically assigned when created",
      "thumbnails" : [ { } ]
    },
    "subdomain" : "The subdomain of the brand",
    "id" : "Automatically assigned when the brand is created"
  }
}

$body#

Type: object

{
  "custom_role" : {
    "role_type" : "The value 0",
    "updated_at" : "The time the record was last updated",
    "configuration" : {
      "voice_access" : "boolean",
      "moderate_forums" : "boolean",
      "user_view_access" : "string. Possible values: full | manage-group | manage-personal | none | readonly",
      "ticket_merge" : "boolean",
      "ticket_access" : "string. Possible values: all | assigned-only | within-groups | within-organization",
      "light_agent" : "boolean",
      "explore_access" : "string. Possible values: edit | full | none | readonly",
      "macro_access" : "string. Possible values: full | manage-group | manage-personal | readonly",
      "organization_notes_editing" : "boolean",
      "view_deleted_tickets" : "boolean",
      "end_user_list_access" : "string. Possible values: full | none",
      "end_user_profile_access" : "string. Possible values: edit | edit-within-org | full | readonly",
      "report_access" : "string. Possible values: full | none | readonly",
      "manage_dynamic_content" : "boolean",
      "forum_access" : "string. Possible values: edit-topics | full | readonly",
      "ticket_comment_access" : "string. Possible values: public | none",
      "twitter_search_access" : "boolean",
      "forum_access_restricted_content" : "boolean",
      "group_access" : "boolean",
      "ticket_editing" : "boolean",
      "manage_business_rules" : "boolean",
      "ticket_deletion" : "boolean",
      "view_access" : "string. Possible values: full | manage-group | manage-personal | playonly | readonly",
      "ticket_tag_editing" : "boolean",
      "manage_facebook" : "boolean",
      "manage_extensions_and_channels" : "boolean",
      "organization_editing" : "boolean",
      "chat_access" : "boolean"
    },
    "name" : "Name of this custom role",
    "description" : "A description of the role",
    "created_at" : "The time the record was created",
    "id" : "Automatically assigned upon creation"
  }
}

$body#

Type: object

{
  "item" : {
    "outdated" : "Indicates the item has outdated variants within it",
    "updated_at" : "When this record last got updated",
    "default_locale_id" : "The default locale for the item. Must be one of the locales the account has active.",
    "name" : "The unique name of the item",
    "created_at" : "When this record was created",
    "id" : "Automatically assigned when creating items",
    "placeholder" : "Automatically generated placeholder for the item, derived from name",
    "variants" : [ {
      "locale_id" : "An active locale",
      "default" : "If the variant is the default for the item it belongs to",
      "outdated" : "If the variant is outdated",
      "updated_at" : "When the variant was last updated",
      "active" : "If the variant is active and useable",
      "created_at" : "When the variant was created",
      "id" : "Automatically assigned when the variant is created",
      "url" : "The API url of the variant",
      "content" : "The content of the variant"
    } ],
    "url" : "The API url of this item"
  }
}

id (required)#

Variant ID

Type: number

$body#

Type: object

{
  "variant" : {
    "locale_id" : "An active locale",
    "default" : "If the variant is the default for the item it belongs to",
    "outdated" : "If the variant is outdated",
    "updated_at" : "When the variant was last updated",
    "active" : "If the variant is active and useable",
    "created_at" : "When the variant was created",
    "id" : "Automatically assigned when the variant is created",
    "url" : "The API url of the variant",
    "content" : "The content of the variant"
  }
}

$body#

Type: object

{
  "group" : {
    "deleted" : "Deleted groups get marked as such",
    "updated_at" : "The time of the last update of the group",
    "name" : "The name of the group",
    "created_at" : "The time the group was created",
    "id" : "Automatically assigned when creating groups",
    "url" : "The API url of this group"
  }
}

$body#

Type: object

{
  "group_membership" : {
    "default" : "If true, tickets assigned directly to the agent will assume this membership's group.",
    "updated_at" : "The time of the last update of the membership",
    "user_id" : "The id of an agent",
    "group_id" : "The id of a group",
    "created_at" : "The time the membership was created",
    "id" : "Automatically assigned upon creation",
    "url" : "The API url of this record"
  }
}

user_id (required)#

User ID

Type: number

$body#

Type: object

{
  "group_membership" : {
    "default" : "If true, tickets assigned directly to the agent will assume this membership's group.",
    "updated_at" : "The time of the last update of the membership",
    "user_id" : "The id of an agent",
    "group_id" : "The id of a group",
    "created_at" : "The time the membership was created",
    "id" : "Automatically assigned upon creation",
    "url" : "The API url of this record"
  }
}

schedule_id (required)#

Schedule ID

Type: number

$body#

Type: object

{
  "holiday" : {
    "end_date" : "ISO 8601 representation of the holiday end date.",
    "name" : "Name of the holiday.",
    "id" : "Automatically assigned upon creation.",
    "start_date" : "ISO 8601 representation of the holiday start date."
  }
}

user_id (required)#

User ID

Type: number

$body#

Type: object

{
  "identity" : {
    "updated_at" : "The time the identity was updated",
    "user_id" : "The id of the user",
    "deliverable_state" : "string. Possible values: deliverable | undeliverable",
    "verified" : "If the identity has been verified",
    "undeliverable_count" : "The number of times a soft-bounce response was received at that address",
    "created_at" : "The time the identity was created",
    "id" : "Automatically assigned on creation",
    "type" : "string. Possible values: email | twitter | facebook | google | phone_number | agent_fowarding | sdk",
    "value" : "The identifier for this identity, such as an email address",
    "url" : "The API url of this identity",
    "primary" : "If the identity is the primary identity. *Writable only when creating, not when updating. Use the Make Identity Primary endpoint instead"
  }
}

user_id (required)#

User ID

Type: number

$body#

Type: object

{
  "identity" : {
    "updated_at" : "The time the identity was updated",
    "user_id" : "The id of the user",
    "deliverable_state" : "string. Possible values: deliverable | undeliverable",
    "verified" : "If the identity has been verified",
    "undeliverable_count" : "The number of times a soft-bounce response was received at that address",
    "created_at" : "The time the identity was created",
    "id" : "Automatically assigned on creation",
    "type" : "string. Possible values: email | twitter | facebook | google | phone_number | agent_fowarding | sdk",
    "value" : "The identifier for this identity, such as an email address",
    "url" : "The API url of this identity",
    "primary" : "If the identity is the primary identity. *Writable only when creating, not when updating. Use the Make Identity Primary endpoint instead"
  }
}

$body#

Type: object

{
  "macro" : {
    "updated_at" : "The time of the last update of the macro",
    "restriction" : { },
    "active" : "Useful for determining if the macro should be displayed",
    "description" : "The description of the macro",
    "created_at" : "The time the macro was created",
    "id" : "Automatically assigned when created",
    "position" : "The position of the macro",
    "title" : "The title of the macro",
    "actions" : {
      "actions" : [ {
        "field" : "The name of a field",
        "value" : "The value of the field"
      } ]
    }
  }
}

id (required)#

DynamicContentItem ID

Type: number

$body#

Type: object

{
  "variants" : [ {
    "locale_id" : "An active locale",
    "default" : "If the variant is the default for the item it belongs to",
    "outdated" : "If the variant is outdated",
    "updated_at" : "When the variant was last updated",
    "active" : "If the variant is active and useable",
    "created_at" : "When the variant was created",
    "id" : "Automatically assigned when the variant is created",
    "url" : "The API url of the variant",
    "content" : "The content of the variant"
  } ]
}

$body#

Type: object

{
  "group_memberships" : [ {
    "default" : "If true, tickets assigned directly to the agent will assume this membership's group.",
    "updated_at" : "The time of the last update of the membership",
    "user_id" : "The id of an agent",
    "group_id" : "The id of a group",
    "created_at" : "The time the membership was created",
    "id" : "Automatically assigned upon creation",
    "url" : "The API url of this record"
  } ]
}

$body#

Type: object

{
  "organization_memberships" : [ {
    "default" : "Denotes whether this is the default organization membership for the user. If false, returns null",
    "updated_at" : "When this record last got updated",
    "user_id" : "The ID of the user for whom this memberships belongs",
    "organization_id" : "The ID of the organization associated with this user, in this membership",
    "created_at" : "When this record was created",
    "id" : "Automatically assigned when the membership is created",
    "url" : "The API url of this membership"
  } ]
}

$body#

Type: object

{
  "organizations" : [ {
    "shared_tickets" : "End users in this organization are able to see each other's tickets",
    "notes" : "Any notes you have about the organization",
    "created_at" : "The time the organization was created",
    "external_id" : "A unique external id to associate organizations to an external record",
    "url" : "The API url of this organization",
    "domain_names" : [ "string" ],
    "tags" : [ "string" ],
    "organization_fields" : { },
    "updated_at" : "The time of the last update of the organization",
    "group_id" : "New tickets from users in this organization are automatically put in this group",
    "name" : "A unique name for the organization",
    "details" : "Any details obout the organization, such as the address",
    "id" : "Automatically assigned when the organization is created",
    "shared_comments" : "End users in this organization are able to see each other's comments on tickets"
  } ]
}

$body#

Type: object

{
  "tickets" : [ {
    "subject" : "The value of the subject field for this ticket",
    "email_cc_ids" : [ "number" ],
    "additional_tags" : [ "string" ],
    "description" : "The first comment on the ticket",
    "created_at" : "When this record was created",
    "external_id" : "An id you can use to link Zendesk Support tickets to local records",
    "macro_ids" : [ "number" ],
    "type" : "The type of this ticket.",
    "updated_stamp" : "If the updated_stamp property does not match the updated_at datetime value for the ticket the update operation will fail and an UpdateConflict error response will be sent.",
    "via" : {
      "channel" : "This tells you how the ticket or event was created.",
      "source" : {
        "rel" : "string",
        "from" : { },
        "to" : { }
      }
    },
    "allow_attachments" : "When an agent responds, are they allowed to add attachments? Defaults to true",
    "updated_at" : "When this record last got updated",
    "problem_id" : "For tickets of type \"incident\", the ID of the problem the incident is linked to",
    "follower_ids" : [ "number" ],
    "collaborators" : [ "number" ],
    "due_at" : "If this is a ticket of type \"task\" it has a due date. Due date format uses ISO 8601 format.",
    "id" : "Automatically assigned when the ticket is created",
    "assignee_id" : "The agent currently assigned to the ticket",
    "raw_subject" : "The dynamic content placeholder, if present, or the \"subject\" value, if not. See Dynamic Content",
    "safe_update" : "When the safe_update property has a value of true, the updated_stamp property is required, and only if the updated_at datetime value on the ticket matches the updated_stamp value will the ticket be updated.",
    "forum_topic_id" : "The topic this ticket originated from, if any",
    "custom_fields" : [ {
      "id" : "number",
      "value" : "string"
    } ],
    "allow_channelback" : "Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket",
    "satisfaction_rating" : { },
    "submitter_id" : "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket",
    "priority" : "The urgency with which the ticket should be addressed.",
    "collaborator_ids" : [ "number" ],
    "url" : "The API url of this ticket",
    "tags" : [ "string" ],
    "brand_id" : "Enterprise only. The id of the brand this ticket is associated with",
    "ticket_form_id" : "Enterprise only. The id of the ticket form to render for the ticket",
    "remove_tags" : [ "string" ],
    "sharing_agreement_ids" : [ "number" ],
    "group_id" : "The group this ticket is assigned to",
    "organization_id" : "The organization of the requester. You can only specify the ID of an organization associated with the requester. See Organization Memberships",
    "followup_ids" : [ "number" ],
    "recipient" : "The original recipient e-mail address of the ticket",
    "via_followup_source_id" : "POST requests only. The id of a closed ticket when creating a follow-up ticket. See Creating Follow-up Tickets",
    "is_public" : "Is true if any comments are public, false otherwise",
    "comment" : {
      "metadata" : { },
      "attachments" : [ {
        "content_type" : "The content type of the image.",
        "size" : "The size of the image file in bytes",
        "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
        "file_name" : "The name of the image file",
        "content_url" : "A full URL where the attachment image file can be downloaded",
        "id" : "Automatically assigned when created",
        "thumbnails" : [ { } ]
      } ],
      "public" : "true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it",
      "html_body" : "The comment formatted as HTML",
      "plain_body" : "The comment as plain text",
      "created_at" : "The time the comment was created",
      "id" : "Automatically assigned when the comment is created",
      "type" : "string. Possible values: Comment | VoiceComment",
      "body" : "The comment string",
      "author_id" : "The id of the comment author.",
      "via" : {
        "channel" : "This tells you how the ticket or event was created.",
        "source" : {
          "rel" : "string",
          "from" : { },
          "to" : { }
        }
      }
    },
    "has_incidents" : "Is true of this ticket has been marked as a problem, false otherwise",
    "status" : "The state of the ticket.",
    "requester_id" : "The user who requested this ticket"
  } ]
}

$body#

Type: object

{
  "users" : [ {
    "shared" : "If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only",
    "last_login_at" : "The last time the user signed in to Zendesk Support",
    "notes" : "Any notes you want to store about the user",
    "role" : "The user's role. Possible values are \"end-user\", \"agent\", or \"admin\"",
    "signature" : "The user's signature. Only agents and admins can have signatures",
    "custom_role_id" : "A custom role if the user is an agent on the Enterprise plan",
    "moderator" : "Designates whether the user has forum moderation capabilities",
    "shared_agent" : "If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only",
    "created_at" : "The time the user was created",
    "external_id" : "A unique identifier from another system. The API treats the id as case insensitive.",
    "locale" : "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.",
    "default_group_id" : "The id of the user's default group. *Can only be set on create, not on update",
    "locale_id" : "The user's language identifier",
    "user_fields" : { },
    "updated_at" : "The time the user was last updated",
    "report_csv" : "Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface. See Analyzing Help Center search results in Help Center. Only available on the Guide Professional plan",
    "alias" : "An alias displayed to end users",
    "details" : "Any details you want to store about the user, such as an address",
    "id" : "Automatically assigned when the user is created",
    "email" : "The user's primary email address. *Writeable on create only. On update, a secondary email is added.",
    "restricted_agent" : "If the agent has any restrictions; false for admins and unrestricted agents, true for other agents",
    "two_factor_auth_enabled" : "If two factor authentication is enabled.",
    "role_type" : "The user's role id. 0 for custom agents, 1 for light agent and 2 for chat agent",
    "only_private_comments" : "true if the user can only create private comments",
    "shared_phone_number" : "Whether the phone number is shared or not. See Phone Number below",
    "verified" : "The user's primary identity is verified or not. For secondary identities, see User Identities",
    "active" : "false if the user has been deleted",
    "photo" : {
      "content_type" : "The content type of the image.",
      "size" : "The size of the image file in bytes",
      "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
      "file_name" : "The name of the image file",
      "content_url" : "A full URL where the attachment image file can be downloaded",
      "id" : "Automatically assigned when created",
      "thumbnails" : [ { } ]
    },
    "time_zone" : "The user's time zone. See Time Zone",
    "suspended" : "If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal",
    "url" : "The user's API url",
    "tags" : [ "string" ],
    "phone" : "The user's primary phone number. See Phone Number below",
    "organization_id" : "The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization",
    "name" : "The user's name",
    "chat_only" : "Whether or not the user is a chat-only agent",
    "ticket_restriction" : "Specifies which tickets the user has access to."
  } ]
}

$body#

Type: object

{
  "client" : {
    "identifier" : "The unique identifier for this client",
    "logo_url" : "The API logo url of this record",
    "description" : "A short description of your client that is displayed to users when they are considering approving access to your application.",
    "created_at" : "The time the client was created",
    "global" : "Whether this client is globally accessible. Learn more",
    "secret" : "The client secret. Generated automatically on creation and returned in full only at that time.",
    "url" : "The API url of this record",
    "updated_at" : "The time of the last update of the client",
    "user_id" : "The id of the admin who created the client",
    "name" : "The name of this client",
    "company" : "Choose a company name to display when users are asked to approve access to your application. The name will help users understand who they are granting access to.",
    "id" : "Automatically assigned upon creation",
    "redirect_uri" : [ "string" ]
  }
}

$body#

Type: object

{
  "token" : {
    "refresh_token" : "The refresh token, if generated",
    "used_at" : "The latest time this token was used for authentication",
    "expires_at" : "The time the token will expire",
    "user_id" : "The id of the user this token authenticates as",
    "created_at" : "The time the token was created",
    "id" : "Automatically assigned upon creation",
    "scopes" : [ "string" ],
    "client_id" : "The id of the client this token belongs to",
    "url" : "The API url of this record",
    "token" : "The access token"
  }
}

$body#

Type: object

{
  "users" : [ {
    "shared" : "If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only",
    "last_login_at" : "The last time the user signed in to Zendesk Support",
    "notes" : "Any notes you want to store about the user",
    "role" : "The user's role. Possible values are \"end-user\", \"agent\", or \"admin\"",
    "signature" : "The user's signature. Only agents and admins can have signatures",
    "custom_role_id" : "A custom role if the user is an agent on the Enterprise plan",
    "moderator" : "Designates whether the user has forum moderation capabilities",
    "shared_agent" : "If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only",
    "created_at" : "The time the user was created",
    "external_id" : "A unique identifier from another system. The API treats the id as case insensitive.",
    "locale" : "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.",
    "default_group_id" : "The id of the user's default group. *Can only be set on create, not on update",
    "locale_id" : "The user's language identifier",
    "user_fields" : { },
    "updated_at" : "The time the user was last updated",
    "report_csv" : "Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface. See Analyzing Help Center search results in Help Center. Only available on the Guide Professional plan",
    "alias" : "An alias displayed to end users",
    "details" : "Any details you want to store about the user, such as an address",
    "id" : "Automatically assigned when the user is created",
    "email" : "The user's primary email address. *Writeable on create only. On update, a secondary email is added.",
    "restricted_agent" : "If the agent has any restrictions; false for admins and unrestricted agents, true for other agents",
    "two_factor_auth_enabled" : "If two factor authentication is enabled.",
    "role_type" : "The user's role id. 0 for custom agents, 1 for light agent and 2 for chat agent",
    "only_private_comments" : "true if the user can only create private comments",
    "shared_phone_number" : "Whether the phone number is shared or not. See Phone Number below",
    "verified" : "The user's primary identity is verified or not. For secondary identities, see User Identities",
    "active" : "false if the user has been deleted",
    "photo" : {
      "content_type" : "The content type of the image.",
      "size" : "The size of the image file in bytes",
      "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
      "file_name" : "The name of the image file",
      "content_url" : "A full URL where the attachment image file can be downloaded",
      "id" : "Automatically assigned when created",
      "thumbnails" : [ { } ]
    },
    "time_zone" : "The user's time zone. See Time Zone",
    "suspended" : "If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal",
    "url" : "The user's API url",
    "tags" : [ "string" ],
    "phone" : "The user's primary phone number. See Phone Number below",
    "organization_id" : "The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization",
    "name" : "The user's name",
    "chat_only" : "Whether or not the user is a chat-only agent",
    "ticket_restriction" : "Specifies which tickets the user has access to."
  } ]
}

$body#

Type: object

{
  "organization" : {
    "shared_tickets" : "End users in this organization are able to see each other's tickets",
    "notes" : "Any notes you have about the organization",
    "created_at" : "The time the organization was created",
    "external_id" : "A unique external id to associate organizations to an external record",
    "url" : "The API url of this organization",
    "domain_names" : [ "string" ],
    "tags" : [ "string" ],
    "organization_fields" : { },
    "updated_at" : "The time of the last update of the organization",
    "group_id" : "New tickets from users in this organization are automatically put in this group",
    "name" : "A unique name for the organization",
    "details" : "Any details obout the organization, such as the address",
    "id" : "Automatically assigned when the organization is created",
    "shared_comments" : "End users in this organization are able to see each other's comments on tickets"
  }
}

$body#

Type: object

{
  "user" : {
    "shared" : "If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only",
    "last_login_at" : "The last time the user signed in to Zendesk Support",
    "notes" : "Any notes you want to store about the user",
    "role" : "The user's role. Possible values are \"end-user\", \"agent\", or \"admin\"",
    "signature" : "The user's signature. Only agents and admins can have signatures",
    "custom_role_id" : "A custom role if the user is an agent on the Enterprise plan",
    "moderator" : "Designates whether the user has forum moderation capabilities",
    "shared_agent" : "If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only",
    "created_at" : "The time the user was created",
    "external_id" : "A unique identifier from another system. The API treats the id as case insensitive.",
    "locale" : "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.",
    "default_group_id" : "The id of the user's default group. *Can only be set on create, not on update",
    "locale_id" : "The user's language identifier",
    "user_fields" : { },
    "updated_at" : "The time the user was last updated",
    "report_csv" : "Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface. See Analyzing Help Center search results in Help Center. Only available on the Guide Professional plan",
    "alias" : "An alias displayed to end users",
    "details" : "Any details you want to store about the user, such as an address",
    "id" : "Automatically assigned when the user is created",
    "email" : "The user's primary email address. *Writeable on create only. On update, a secondary email is added.",
    "restricted_agent" : "If the agent has any restrictions; false for admins and unrestricted agents, true for other agents",
    "two_factor_auth_enabled" : "If two factor authentication is enabled.",
    "role_type" : "The user's role id. 0 for custom agents, 1 for light agent and 2 for chat agent",
    "only_private_comments" : "true if the user can only create private comments",
    "shared_phone_number" : "Whether the phone number is shared or not. See Phone Number below",
    "verified" : "The user's primary identity is verified or not. For secondary identities, see User Identities",
    "active" : "false if the user has been deleted",
    "photo" : {
      "content_type" : "The content type of the image.",
      "size" : "The size of the image file in bytes",
      "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
      "file_name" : "The name of the image file",
      "content_url" : "A full URL where the attachment image file can be downloaded",
      "id" : "Automatically assigned when created",
      "thumbnails" : [ { } ]
    },
    "time_zone" : "The user's time zone. See Time Zone",
    "suspended" : "If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal",
    "url" : "The user's API url",
    "tags" : [ "string" ],
    "phone" : "The user's primary phone number. See Phone Number below",
    "organization_id" : "The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization",
    "name" : "The user's name",
    "chat_only" : "Whether or not the user is a chat-only agent",
    "ticket_restriction" : "Specifies which tickets the user has access to."
  }
}

$body#

Type: object

{
  "organization" : {
    "shared_tickets" : "End users in this organization are able to see each other's tickets",
    "notes" : "Any notes you have about the organization",
    "created_at" : "The time the organization was created",
    "external_id" : "A unique external id to associate organizations to an external record",
    "url" : "The API url of this organization",
    "domain_names" : [ "string" ],
    "tags" : [ "string" ],
    "organization_fields" : { },
    "updated_at" : "The time of the last update of the organization",
    "group_id" : "New tickets from users in this organization are automatically put in this group",
    "name" : "A unique name for the organization",
    "details" : "Any details obout the organization, such as the address",
    "id" : "Automatically assigned when the organization is created",
    "shared_comments" : "End users in this organization are able to see each other's comments on tickets"
  }
}

$body#

Type: object

{
  "organization_field" : {
    "raw_title" : "The dynamic content placeholder, if present, or the \"title\" value, if not.",
    "custom_field_options" : [ "string" ],
    "description" : "User-defined description of this field's purpose",
    "active" : "If true, this field is available for use",
    "created_at" : "The time the ticket field was created",
    "type" : "string. Possible values: checkbox | date | decimal | dropdown | integer | regexp | text | textarea | tagger",
    "title" : "The title of the custom field",
    "raw_description" : "The dynamic content placeholder, if present, or the \"description\" value, if not.",
    "url" : "The URL for this resource",
    "system" : "If true, only active and position values of this field can be changed",
    "updated_at" : "The time of the last update of the ticket field",
    "regexp_for_validation" : "Regular expression field only. The validation pattern for a field value to be deemed valid.",
    "id" : "Automatically assigned upon creation",
    "position" : "Ordering of the field relative to other fields",
    "tag" : "Optional for custom field of type \"checkbox\"; not presented otherwise.",
    "key" : "A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders."
  }
}

$body#

Type: object

{
  "organization_membership" : {
    "default" : "Denotes whether this is the default organization membership for the user. If false, returns null",
    "updated_at" : "When this record last got updated",
    "user_id" : "The ID of the user for whom this memberships belongs",
    "organization_id" : "The ID of the organization associated with this user, in this membership",
    "created_at" : "When this record was created",
    "id" : "Automatically assigned when the membership is created",
    "url" : "The API url of this membership"
  }
}

user_id (required)#

User ID

Type: number

$body#

Type: object

{
  "organization_membership" : {
    "default" : "Denotes whether this is the default organization membership for the user. If false, returns null",
    "updated_at" : "When this record last got updated",
    "user_id" : "The ID of the user for whom this memberships belongs",
    "organization_id" : "The ID of the organization associated with this user, in this membership",
    "created_at" : "When this record was created",
    "id" : "Automatically assigned when the membership is created",
    "url" : "The API url of this membership"
  }
}

$body#

Type: object

{
  "organization_subscription" : {
    "updated_at" : "When this record last got updated",
    "organization_id" : "The ID of the organization associated with this user, in this membership",
    "created_at" : "When this record was created",
    "id" : "Automatically assigned when the membership is created"
  }
}

$body#

Type: object

{
  "recipient_address" : {
    "cname_status" : "Whether all of the required CNAME records are set.",
    "forwarding_status" : "Status of email forwarding.",
    "created_at" : "When the address was created",
    "spf_status" : "Whether the SPF record is set up correctly.",
    "brand_id" : "The ID of the brand",
    "default" : "Whether the address is the account's default support address",
    "ses_status" : "Whether the SES domain verification is valid.",
    "updated_at" : "When the address was updated",
    "name" : "The name for the address",
    "id" : "Automatically assigned when created",
    "domain_verification_status" : "Whether the domain verification record is valid.",
    "email" : "The email address (not updateable)",
    "domain_verification_code" : "Verification string to be added as a TXT record to the domain. Possible types: string or null."
  }
}

$body#

Type: object

{
  "request" : {
    "subject" : "The value of the subject field for this request if the subject field is visible to end users; a truncated version of the description otherwise",
    "custom_fields" : [ {
      "id" : "number",
      "value" : "string"
    } ],
    "email_cc_ids" : [ "integer" ],
    "description" : "The first comment on the request",
    "solved" : "Whether or not request is solved (an end user can set this if \"can_be_solved_by_me\", above, is true for that user)",
    "created_at" : "When this record was created",
    "priority" : "The priority of the request",
    "type" : "The type of the request",
    "collaborator_ids" : [ "integer" ],
    "url" : "The API url of this request",
    "via" : {
      "channel" : "This tells you how the ticket or event was created.",
      "source" : {
        "rel" : "string",
        "from" : { },
        "to" : { }
      }
    },
    "ticket_form_id" : "The numeric id of the ticket form associated with this request if the form is visible to end users - only applicable for enterprise accounts",
    "updated_at" : "When this record last got updated",
    "followup_source_id" : "The id of the original ticket if this request is a follow-up ticket",
    "group_id" : "The id of the assigned group if the field is visible to end users",
    "can_be_solved_by_me" : "If true, end user can mark request as solved.",
    "organization_id" : "The organization of the requester",
    "is_public" : "Is true if any comments are public, false otherwise",
    "recipient" : "The original recipient e-mail address of the request",
    "due_at" : "When the task is due (only applies if the request is of type \"task\")",
    "id" : "Automatically assigned when creating requests",
    "status" : "The state of the request",
    "requester_id" : "The id of the requester",
    "assignee_id" : "The id of the assignee if the field is visible to end users"
  }
}

$body#

Type: object

{
  "resource_collection" : {
    "updated_at" : "The time the identity got updated",
    "created_at" : "The time the identity got created",
    "id" : "Automatically assigned upon creation"
  }
}

$body#

Type: object

{
  "schedule" : {
    "intervals" : [ {
      "start_time" : "Integer representation of the interval start time",
      "end_time" : "Integer representation of the interval end time"
    } ],
    "updated_at" : "Time the schedule was last updated",
    "name" : "Name of the schedule",
    "created_at" : "Time the schedule was created",
    "id" : "Automatically assigned upon creation",
    "time_zone" : "Time zone of the schedule"
  }
}

$body#

Type: object

{
  "sharing_agreement" : {
    "partner_name" : "Can be either 'jira' or null",
    "remote_subdomain" : "Subdomain of the remote account or null if not associated with an account",
    "name" : "Name of this sharing agreement",
    "created_at" : "The time the record was created",
    "id" : "Automatically assigned upon creation",
    "type" : "string. Possible values: inbound | outbound",
    "status" : "string. Possible values: accepted | declined | pending | inactive"
  }
}

$body#

Type: object

{
  "target" : {
    "resource" : "string. Possible values: todo | message",
    "target_url" : "The URL of your Basecamp account, including protocol and path",
    "active" : "Whether or not the target is activated",
    "created_at" : "The time the target was created",
    "message_id" : "Can be filled if it is a \"todo\" resource",
    "title" : "A name for the target",
    "type" : "string",
    "token" : "Get the API token from My info > Show your tokens > Token for feed readers or the Basecamp API in your Basecamp account",
    "todo_list_id" : "Can be filled if it is a \"message\" resource",
    "password" : "The 37Signals password for the Basecamp account (only writable)",
    "project_id" : "The ID of the project in Basecamp where updates should be pushed",
    "id" : "Automatically assigned when created",
    "username" : "The 37Signals username of the account you use to log in to Basecamp"
  }
}

$body#

Type: object

{
  "ticket" : {
    "subject" : "The value of the subject field for this ticket",
    "email_cc_ids" : [ "number" ],
    "additional_tags" : [ "string" ],
    "description" : "The first comment on the ticket",
    "created_at" : "When this record was created",
    "external_id" : "An id you can use to link Zendesk Support tickets to local records",
    "macro_ids" : [ "number" ],
    "type" : "The type of this ticket.",
    "updated_stamp" : "If the updated_stamp property does not match the updated_at datetime value for the ticket the update operation will fail and an UpdateConflict error response will be sent.",
    "via" : {
      "channel" : "This tells you how the ticket or event was created.",
      "source" : {
        "rel" : "string",
        "from" : { },
        "to" : { }
      }
    },
    "allow_attachments" : "When an agent responds, are they allowed to add attachments? Defaults to true",
    "updated_at" : "When this record last got updated",
    "problem_id" : "For tickets of type \"incident\", the ID of the problem the incident is linked to",
    "follower_ids" : [ "number" ],
    "collaborators" : [ "number" ],
    "due_at" : "If this is a ticket of type \"task\" it has a due date. Due date format uses ISO 8601 format.",
    "id" : "Automatically assigned when the ticket is created",
    "assignee_id" : "The agent currently assigned to the ticket",
    "raw_subject" : "The dynamic content placeholder, if present, or the \"subject\" value, if not. See Dynamic Content",
    "safe_update" : "When the safe_update property has a value of true, the updated_stamp property is required, and only if the updated_at datetime value on the ticket matches the updated_stamp value will the ticket be updated.",
    "forum_topic_id" : "The topic this ticket originated from, if any",
    "custom_fields" : [ {
      "id" : "number",
      "value" : "string"
    } ],
    "allow_channelback" : "Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket",
    "satisfaction_rating" : { },
    "submitter_id" : "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket",
    "priority" : "The urgency with which the ticket should be addressed.",
    "collaborator_ids" : [ "number" ],
    "url" : "The API url of this ticket",
    "tags" : [ "string" ],
    "brand_id" : "Enterprise only. The id of the brand this ticket is associated with",
    "ticket_form_id" : "Enterprise only. The id of the ticket form to render for the ticket",
    "remove_tags" : [ "string" ],
    "sharing_agreement_ids" : [ "number" ],
    "group_id" : "The group this ticket is assigned to",
    "organization_id" : "The organization of the requester. You can only specify the ID of an organization associated with the requester. See Organization Memberships",
    "followup_ids" : [ "number" ],
    "recipient" : "The original recipient e-mail address of the ticket",
    "via_followup_source_id" : "POST requests only. The id of a closed ticket when creating a follow-up ticket. See Creating Follow-up Tickets",
    "is_public" : "Is true if any comments are public, false otherwise",
    "comment" : {
      "metadata" : { },
      "attachments" : [ {
        "content_type" : "The content type of the image.",
        "size" : "The size of the image file in bytes",
        "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
        "file_name" : "The name of the image file",
        "content_url" : "A full URL where the attachment image file can be downloaded",
        "id" : "Automatically assigned when created",
        "thumbnails" : [ { } ]
      } ],
      "public" : "true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it",
      "html_body" : "The comment formatted as HTML",
      "plain_body" : "The comment as plain text",
      "created_at" : "The time the comment was created",
      "id" : "Automatically assigned when the comment is created",
      "type" : "string. Possible values: Comment | VoiceComment",
      "body" : "The comment string",
      "author_id" : "The id of the comment author.",
      "via" : {
        "channel" : "This tells you how the ticket or event was created.",
        "source" : {
          "rel" : "string",
          "from" : { },
          "to" : { }
        }
      }
    },
    "has_incidents" : "Is true of this ticket has been marked as a problem, false otherwise",
    "status" : "The state of the ticket.",
    "requester_id" : "The user who requested this ticket"
  }
}

$body#

Type: object

{
  "ticket_field" : {
    "raw_title" : "The dynamic content placeholder, if present, or the \"title\" value, if not.",
    "custom_field_options" : [ {
      "raw_name" : "string",
      "name" : "string",
      "id" : "integer",
      "position" : "integer",
      "value" : "string",
      "url" : "string"
    } ],
    "visible_in_portal" : "Whether this field is available to end users",
    "description" : "The description of the purpose of this ticket field, shown to users",
    "created_at" : "The time the ticket field was created",
    "type" : "The type of the ticket field. Type is not editable once created.",
    "title" : "The title of the ticket field",
    "required" : "If it's required for this field to have a value when updated by agents",
    "editable_in_portal" : "Whether this field is editable by end users",
    "updated_at" : "The time of the last update of the ticket field",
    "system_field_options" : [ {
      "raw_name" : "string",
      "name" : "string",
      "id" : "integer",
      "position" : "integer",
      "value" : "string",
      "url" : "string"
    } ],
    "regexp_for_validation" : "Regular expression field only. The validation pattern for a field value to be deemed valid.",
    "id" : "Automatically assigned upon creation",
    "tag" : "A tag value to set for checkbox fields when checked",
    "collapsed_for_agents" : "If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only",
    "active" : "Whether this field is available",
    "raw_title_in_portal" : "The dynamic content placeholder, if present, or the \"title_in_portal\" value, if not. See Dynamic Content",
    "agent_description" : "A description of the ticket field that only agents can see",
    "raw_description" : "The dynamic content placeholder, if present, or the \"description\" value, if not. See Dynamic Content",
    "url" : "The URL for this resource",
    "required_in_portal" : "If it's required for this field to have a value when updated by end users",
    "removable" : "If this field is not a system basic field that must be present for all tickets on the account",
    "sub_type_id" : "\"priority\" and \"status\" fields only, inaccessible to all other field types. Defaults to 0. A \"priority\" sub type of 1 removes the \"Low\" and \"Urgent\" options. A \"status\" sub type of 1 adds the \"On-Hold\" option.",
    "position" : "A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields",
    "title_in_portal" : "The title of the ticket field is mandatory when it's visible to end users"
  }
}

$body#

Type: object

{
  "ticket_form" : {
    "raw_name" : "The dynamic content placeholder, if present, or the \"name\" value, if not. See Dynamic Content",
    "in_all_brands" : "Is the form available for use in all brands on this account",
    "ticket_field_ids" : [ "string" ],
    "active" : "If the form is set as active",
    "agent_conditions" : [ { } ],
    "raw_display_name" : "The dynamic content placeholder, if present, or the \"display_name\" value, if not. See Dynamic Content",
    "display_name" : "The name of the form that is displayed to an end user",
    "default" : "Is the form the default form for this account",
    "end_user_conditions" : [ { } ],
    "end_user_visible" : "Is the form visible to the end user",
    "name" : "The name of the form",
    "position" : "The position of this form among other forms in the account, i.e. dropdown",
    "restricted_brand_ids" : [ "number" ]
  }
}

$body#

Type: object

{
  "ticket" : {
    "monitored_twitter_handle_id" : "number",
    "twitter_status_message_id" : "string"
  }
}

$body#

Type: object

{
  "ticket_skip" : {
    "reason" : "Reason for skipping the ticket",
    "ticket" : {
      "subject" : "The value of the subject field for this ticket",
      "email_cc_ids" : [ "number" ],
      "additional_tags" : [ "string" ],
      "description" : "The first comment on the ticket",
      "created_at" : "When this record was created",
      "external_id" : "An id you can use to link Zendesk Support tickets to local records",
      "macro_ids" : [ "number" ],
      "type" : "The type of this ticket.",
      "updated_stamp" : "If the updated_stamp property does not match the updated_at datetime value for the ticket the update operation will fail and an UpdateConflict error response will be sent.",
      "via" : {
        "channel" : "This tells you how the ticket or event was created.",
        "source" : {
          "rel" : "string",
          "from" : { },
          "to" : { }
        }
      },
      "allow_attachments" : "When an agent responds, are they allowed to add attachments? Defaults to true",
      "updated_at" : "When this record last got updated",
      "problem_id" : "For tickets of type \"incident\", the ID of the problem the incident is linked to",
      "follower_ids" : [ "number" ],
      "collaborators" : [ "number" ],
      "due_at" : "If this is a ticket of type \"task\" it has a due date. Due date format uses ISO 8601 format.",
      "id" : "Automatically assigned when the ticket is created",
      "assignee_id" : "The agent currently assigned to the ticket",
      "raw_subject" : "The dynamic content placeholder, if present, or the \"subject\" value, if not. See Dynamic Content",
      "safe_update" : "When the safe_update property has a value of true, the updated_stamp property is required, and only if the updated_at datetime value on the ticket matches the updated_stamp value will the ticket be updated.",
      "forum_topic_id" : "The topic this ticket originated from, if any",
      "custom_fields" : [ {
        "id" : "number",
        "value" : "string"
      } ],
      "allow_channelback" : "Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket",
      "satisfaction_rating" : { },
      "submitter_id" : "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket",
      "priority" : "The urgency with which the ticket should be addressed.",
      "collaborator_ids" : [ "number" ],
      "url" : "The API url of this ticket",
      "tags" : [ "string" ],
      "brand_id" : "Enterprise only. The id of the brand this ticket is associated with",
      "ticket_form_id" : "Enterprise only. The id of the ticket form to render for the ticket",
      "remove_tags" : [ "string" ],
      "sharing_agreement_ids" : [ "number" ],
      "group_id" : "The group this ticket is assigned to",
      "organization_id" : "The organization of the requester. You can only specify the ID of an organization associated with the requester. See Organization Memberships",
      "followup_ids" : [ "number" ],
      "recipient" : "The original recipient e-mail address of the ticket",
      "via_followup_source_id" : "POST requests only. The id of a closed ticket when creating a follow-up ticket. See Creating Follow-up Tickets",
      "is_public" : "Is true if any comments are public, false otherwise",
      "comment" : {
        "metadata" : { },
        "attachments" : [ {
          "content_type" : "The content type of the image.",
          "size" : "The size of the image file in bytes",
          "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
          "file_name" : "The name of the image file",
          "content_url" : "A full URL where the attachment image file can be downloaded",
          "id" : "Automatically assigned when created",
          "thumbnails" : [ { } ]
        } ],
        "public" : "true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it",
        "html_body" : "The comment formatted as HTML",
        "plain_body" : "The comment as plain text",
        "created_at" : "The time the comment was created",
        "id" : "Automatically assigned when the comment is created",
        "type" : "string. Possible values: Comment | VoiceComment",
        "body" : "The comment string",
        "author_id" : "The id of the comment author.",
        "via" : {
          "channel" : "This tells you how the ticket or event was created.",
          "source" : {
            "rel" : "string",
            "from" : { },
            "to" : { }
          }
        }
      },
      "has_incidents" : "Is true of this ticket has been marked as a problem, false otherwise",
      "status" : "The state of the ticket.",
      "requester_id" : "The user who requested this ticket"
    },
    "updated_at" : "Time the skip was last updated",
    "user_id" : "ID of the skipping agent",
    "created_at" : "Time the skip was created",
    "id" : "Automatically assigned upon creation",
    "ticket_id" : "ID of the skipped ticket"
  }
}

$body#

Type: object

{
  "trigger" : {
    "updated_at" : "The time of the last update of the trigger",
    "active" : "Whether the trigger is active",
    "description" : "The description of the trigger",
    "created_at" : "The time the trigger was created",
    "id" : "Automatically assigned when created",
    "position" : "Position of the trigger, determines the order they will execute in",
    "title" : "The title of the trigger",
    "conditions" : {
      "all" : [ {
        "field" : "The name of a ticket field",
        "value" : "The value of a ticket field",
        "operator" : "A comparison operator"
      } ],
      "any" : [ {
        "field" : "The name of a ticket field",
        "value" : "The value of a ticket field",
        "operator" : "A comparison operator"
      } ]
    },
    "actions" : [ {
      "field" : "The name of a field",
      "value" : "The value of the field"
    } ]
  }
}

$body#

Type: object

{
  "user" : {
    "shared" : "If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only",
    "last_login_at" : "The last time the user signed in to Zendesk Support",
    "notes" : "Any notes you want to store about the user",
    "role" : "The user's role. Possible values are \"end-user\", \"agent\", or \"admin\"",
    "signature" : "The user's signature. Only agents and admins can have signatures",
    "custom_role_id" : "A custom role if the user is an agent on the Enterprise plan",
    "moderator" : "Designates whether the user has forum moderation capabilities",
    "shared_agent" : "If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only",
    "created_at" : "The time the user was created",
    "external_id" : "A unique identifier from another system. The API treats the id as case insensitive.",
    "locale" : "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.",
    "default_group_id" : "The id of the user's default group. *Can only be set on create, not on update",
    "locale_id" : "The user's language identifier",
    "user_fields" : { },
    "updated_at" : "The time the user was last updated",
    "report_csv" : "Whether or not the user can access the CSV report on the Search tab of the Reporting page in the Support admin interface. See Analyzing Help Center search results in Help Center. Only available on the Guide Professional plan",
    "alias" : "An alias displayed to end users",
    "details" : "Any details you want to store about the user, such as an address",
    "id" : "Automatically assigned when the user is created",
    "email" : "The user's primary email address. *Writeable on create only. On update, a secondary email is added.",
    "restricted_agent" : "If the agent has any restrictions; false for admins and unrestricted agents, true for other agents",
    "two_factor_auth_enabled" : "If two factor authentication is enabled.",
    "role_type" : "The user's role id. 0 for custom agents, 1 for light agent and 2 for chat agent",
    "only_private_comments" : "true if the user can only create private comments",
    "shared_phone_number" : "Whether the phone number is shared or not. See Phone Number below",
    "verified" : "The user's primary identity is verified or not. For secondary identities, see User Identities",
    "active" : "false if the user has been deleted",
    "photo" : {
      "content_type" : "The content type of the image.",
      "size" : "The size of the image file in bytes",
      "inline" : "If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false",
      "file_name" : "The name of the image file",
      "content_url" : "A full URL where the attachment image file can be downloaded",
      "id" : "Automatically assigned when created",
      "thumbnails" : [ { } ]
    },
    "time_zone" : "The user's time zone. See Time Zone",
    "suspended" : "If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal",
    "url" : "The user's API url",
    "tags" : [ "string" ],
    "phone" : "The user's primary phone number. See Phone Number below",
    "organization_id" : "The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization",
    "name" : "The user's name",
    "chat_only" : "Whether or not the user is a chat-only agent",
    "ticket_restriction" : "Specifies which tickets the user has access to."
  }
}

$body#

Type: object

{
  "user_field" : {
    "raw_title" : "The dynamic content placeholder, if present, or the \"title\" value, if not. See Dynamic Content",
    "custom_field_options" : [ {
      "raw_name" : "string",
      "name" : "string",
      "id" : "number",
      "position" : "integer",
      "value" : "string",
      "url" : "string"
    } ],
    "description" : "User-defined description of this field's purpose",
    "active" : "If true, this field is available for use",
    "created_at" : "The time the ticket field was created",
    "type" : "Type of the custom field",
    "title" : "The title of the custom field",
    "raw_description" : "The dynamic content placeholder, if present, or the \"description\" value, if not. See Dynamic Content",
    "url" : "The URL for this resource",
    "system" : "If true, only active and position values of this field can be changed",
    "updated_at" : "The time of the last update of the ticket field",
    "regexp_for_validation" : "Regular expression field only. The validation pattern for a field value to be deemed valid.",
    "id" : "Automatically assigned upon creation",
    "position" : "Ordering of the field relative to other fields",
    "tag" : "Optional for custom field of type \"checkbox\"; not presented otherwise.",
    "key" : "A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders."
  }
}

$body#

Type: object

{
  "workspace" : {
    "description" : "User-defined description of this workspace's purpose",
    "created_at" : "The time the workspace was created",
    "macro_ids" : [ "number" ],
    "prefer_workspace_app_order" : "boolean",
    "title" : "The title of the workspace",
    "url" : "The URL for this resource",
    "ticket_form_id" : "number",
    "updated_at" : "The time of the last update of the workspace",
    "selected_macros" : [ { } ],
    "id" : "Automatically assigned upon creation",
    "position" : "Ordering of the workspace relative to other workspaces",
    "conditions" : { },
    "activated" : "If true, this workspace is available for use",
    "apps" : [ { } ]
  }
}

id (required)#

Automation ID

Type: number

id (required)#

Bookmark ID

Type: number

id (required)#

Brand ID

Type: number

id (required)#

Role ID

Type: number

user_id (required)#

User ID

Type: number

id (required)#

DynamicContentItem ID

Type: number

id (required)#

DynamicContentItem ID

Type: number

variant_id (required)#

Variant ID

Type: number

group_id (required)#

Group ID

Type: number

group_membership_id (required)#

Group Membership ID

Type: number

group_membership_id (required)#

Group Membership ID

Type: number

user_id (required)#

User ID

Type: number

holiday_id (required)#

Holiday ID

Type: number

schedule_id (required)#

Schedule ID

Type: number

id (required)#

Identity ID

Type: number

user_id (required)#

User ID

Type: number

id (required)#

Macro ID

Type: number

ids#

Type: array

[ "number" ]

oauth_client_id (required)#

OAuth Client ID

Type: number

id (required)#

Oauth Token ID

Type: number

organization_id (required)#

Organization ID

Type: number

id (required)#

OrganizationField ID

Type: number

id (required)#

OrganizationMembership ID

Type: number

id (required)#

OrganizationMembership ID

Type: number

user_id (required)#

User ID

Type: number

id (required)#

OrganizationSubscription ID

Type: number

id (required)#

SupportAddress ID

Type: number

id (required)#

ResourceCollection ID

Type: number

schedule_id (required)#

Schedule ID

Type: number

id (required)#

Sharing Agreement ID

Type: number

suspended_ticket_id (required)#

Suspended Ticket ID

Type: number

id (required)#

Target ID

Type: number

ticket_id (required)#

Ticket ID

Type: number

ticket_field_id (required)#

Ticket Field ID

Type: number

option_id (required)#

Type: integer

ticket_field_id (required)#

Ticket Field ID

Type: number

ticket_form_id (required)#

Ticket Form ID

Type: number

id (required)#

Role ID

Type: number

trigger_id (required)#

Trigger ID

Type: number

user_id (required)#

User ID

Type: number

user_field_id (required)#

User Field ID

Type: number

option_id (required)#

Type: integer

user_field_id (required)#

User Field ID

Type: number

workspace_id (required)#

Workspace ID

Type: number

ids#

Automation IDs to delete

Type: array

[ "number" ]

ids#

Group Membership IDs to delete

Type: array

[ "number" ]

ids#

Macro IDs to delete

Type: array

[ "number" ]

ids#

OrganizationMembership IDs to delete

Type: array

[ "number" ]

external_ids#

External IDs to delete

Type: array

[ "number" ]

ids#

Organization IDs to delete

Type: array

[ "number" ]

ids#

Suspended Ticket IDs to delete

Type: array

[ "number" ]

ids#

Ticket IDs to delete

Type: array

[ "number" ]