younifyd
Menu

Create Request

Create Request

POST/api/v2/requests

Use it in a workflow

  1. Add a step and choose the Zendesk connector.
  2. Pick the Create Request action (under Requests).
  3. Fill in the fields below, then reference the result from later steps as {{createRequest.response.data}}.

Fields

baseUrlstring

The API host this action calls. Override to point at a different environment.

Default "https://{subdomain}.{domain}.com"

bodystring

The request body content (for POST, PUT, PATCH requests).

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

Returns 201 with an object. Read it in later steps with {{createRequest.response.data.<field>}}.

requestobject
assignee_idinteger (int64)

The id of the assignee if the field is visible to end users

can_be_solved_by_meboolean

If true, an end user can mark the request as solved. See [Update Request](/api-reference/ticketing/tickets/ticket-requests/#update-request)

collaborator_idsarray<integer (int64)>

The ids of users currently CC'ed on the ticket

created_atstring (date-time)

When this record was created

custom_fieldsarray<object>2 fields

Custom fields for the request. See [Setting custom field values](/api-reference/ticketing/tickets/tickets/#setting-custom-field-values) in the Tickets doc

custom_status_idinteger (int64)

The custom ticket status id of the ticket

descriptionstring

Read-only first comment on the request. When [creating a request](#create-request), use `comment` to set the description

due_atstring (date-time)

When the task is due (only applies if the request is of type "task")

email_cc_idsarray<integer (int64)>

The ids of users who are currently email CCs on the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/4408822451482) in the Support Help Center

followup_source_idinteger (int64)

The id of the original ticket if this request is a follow-up ticket. See [Create Request](#create-request)

group_idinteger (int64)

The id of the assigned group if the field is visible to end users

idinteger (int64)

Automatically assigned when creating requests

is_publicboolean

Is true if any comments are public, false otherwise

organization_idinteger (int64)

The organization of the requester

prioritystring

The priority of the request, "low", "normal", "high", "urgent"

recipientstring

The original recipient e-mail address of the request

requester_idinteger (int64)

The id of the requester

solvedboolean

Whether or not request is solved (an end user can set this if "can_be_solved_by_me", above, is true for that user)

statusstring

The state of the request, "new", "open", "pending", "hold", "solved", "closed"

subjectstringrequired

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

ticket_form_idinteger (int64)

The numeric id of the ticket form associated with this request if the form is visible to end users - only applicable for enterprise accounts

typestring

The type of the request, "question", "incident", "problem", "task"

updated_atstring (date-time)

When this record last got updated

urlstring

The API url of this request

viaobject2 fields

Describes how the object was created. See the [Via object reference](/documentation/ticketing/reference-guides/via-object-reference)

json
{
  "request": {
    "assignee_id": 72983,
    "can_be_solved_by_me": false,
    "collaborator_ids": [],
    "created_at": "2009-07-20T22:55:29Z",
    "description": "The fire is very colorful.",
    "due_at": "2011-05-24T12:00:00Z",
    "group_id": 8665,
    "id": 35436,
    "organization_id": 509974,
    "priority": "normal",
    "requester_id": 1462,
    "status": "open",
    "subject": "Help, my printer is on fire!",
    "ticket_form_id": 2,
    "type": "problem",
    "updated_at": "2011-05-05T10:38:52Z",
    "url": "https://company.zendesk.com/api/v2/requests/35436",
    "via": {
      "channel": "web"
    }
  }
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.