NPS® Recipients

Every NPS survey is delivered to one or multiple recipients. For most businesses that use Zendesk Support, the recipients are customers. Agents and admins will never receive surveys. If the recipient responds to the survey, they’ll then become a user in your instance of Zendesk Support. If they’re already a user in your Zendesk Support instance, their NPS response will be associated with their user ID. If they’re not an existing user in your Zendesk Support instance, a unique user ID will be created on their behalf to capture their response. Visit the Incremental Export documentation for information on how to export all recipients across surveys.

JSON Format

Recipients are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
created_at string true false When the recipient was created.
delivered_at string true false When the survey was delivered to the recipient.
email string false true The email of the recipient.
id integer true false Automatically assigned when the recipient is created.
locale string false false The recipient's locale.
name string false true The name of the recipient.
updated_at string true false When recipient was last updated (i.e., by responding to the survey).
user_id integer true false The recipient user ID.
Example
{
  "created_at": "2013-08-29T00:00:00-07:00",
  "delivered_at": "2013-08-29T00:00:30-07:00",
  "email": "[email protected]",
  "id": 1,
  "locale": "en-US",
  "name": "Recipient Name",
  "updated_at": "2013-08-29T00:00:30-07:00",
  "user_id": 154506367
}

List Recipients

  • GET /api/v2/nps/surveys/{survey_id}/recipients

List recipients for a given survey.

Allowed for
  • Admins
Parameters
Name Type In Required Description
survey_id integer Path true ID of survey.
Using curl
curl https://{subdomain}.zendesk.com/api/v2/nps/surveys/{survey_id}/recipients.json \
  -v -u {email_address}:{password}
Example Response
Status 200 OK

{
  "recipients": [
    {
      "created_at": "2020-07-01T18:00:00Z",
      "delivered_at": "2020-07-01T20:00:00Z",
      "email": "[email protected]",
      "id": 1,
      "locale": "en-US",
      "name": "Recipient One",
      "updated_at": "2020-07-01T18:00:00Z",
      "user_id": null
    }
  ]
}

Create Recipient

  • POST /api/v2/nps/surveys/{survey_id}/recipients

Creates a new recipient for a survey.

Allowed for
  • Admins
Parameters
Name Type In Required Description
survey_id integer Path true ID of survey.
Example Body
{
  "recipient": {
    "email": "[email protected]",
    "name": "Recipient One"
  }
}
Using curl
curl \
  --data '{"recipient": {"email": "[email protected]", "name": "Recipient One"}}' \
  --header "Content-Type: application/json" \
  --request POST \
  -v -u {email_address}:{password}
    https://{subdomain}.zendesk.com/api/v2/nps/surveys/{survey_id}/recipients.json
Example Response
Status 201 Created

{
  "recipient": {
    "created_at": "2020-07-01T18:00:00Z",
    "delivered_at": "2020-07-01T20:00:00Z",
    "email": "[email protected]",
    "id": 1,
    "locale": "en-US",
    "name": "Recipient One",
    "updated_at": "2020-07-01T18:00:00Z",
    "user_id": null
  }
}

Search Recipients

  • GET /api/v2/nps/surveys/{survey_id}/recipients/search?email={email}

Searches recipients by email address.

Allowed for
  • Admins
Parameters
Name Type In Required Description
email string Query true Email address.
survey_id integer Path true ID of survey.
Using curl
curl https://{subdomain}.zendesk.com/api/v2/nps/surveys/{survey_id}/recipients/search.json?email={email} \
  -v -u {email_address}:{password}
Example Response
Status 200 OK

{
  "recipients": [
    {
      "created_at": "2020-07-01T18:00:00Z",
      "delivered_at": "2020-07-01T20:00:00Z",
      "email": "[email protected]",
      "id": 1,
      "locale": "en-US",
      "name": "Recipient One",
      "updated_at": "2020-07-01T18:00:00Z",
      "user_id": null
    }
  ]
}

Show Recipient

  • GET /api/v2/nps/surveys/{survey_id}/recipients/{recipient_id}

Shows an existing recipient for a survey.

Allowed for
  • Admins
Parameters
Name Type In Required Description
recipient_id integer Path true ID of survey recipient.
survey_id integer Path true ID of survey.
Using curl
curl https://{subdomain}.zendesk.com/api/v2/nps/surveys/{survey_id}/recipients/{recipient_id}.json \
  -v -u {email_address}:{password}
Example Response
Status 200 OK

{
  "recipient": {
    "created_at": "2020-07-01T18:00:00Z",
    "delivered_at": "2020-07-01T20:00:00Z",
    "email": "[email protected]",
    "id": 1,
    "locale": "en-US",
    "name": "Recipient One",
    "updated_at": "2020-07-01T18:00:00Z",
    "user_id": null
  }
}

Update Recipient

  • PUT /api/v2/nps/surveys/{survey_id}/recipients/{recipient_id}

Updates an existing recipient for a survey.

Allowed for
  • Admins
Parameters
Name Type In Required Description
recipient_id integer Path true ID of survey recipient.
survey_id integer Path true ID of survey.
Example Body
{
  "recipient": {
    "email": "[email protected]",
    "name": "Recipient One"
  }
}
Using curl
curl \
  --data '{"recipient": {"email": "[email protected]", "name": "Recipient One"}}' \
  --header "Content-Type: application/json" \
  --request PUT \
  -v -u {email_address}:{password} \
    https://{subdomain}.zendesk.com/api/v2/nps/surveys/{survey_id}/recipients/{recipient_id}.json
Example Response
Status 200 OK

{
  "recipient": {
    "created_at": "2020-07-01T18:00:00Z",
    "delivered_at": "2020-07-01T20:00:00Z",
    "email": "[email protected]",
    "id": 1,
    "locale": "en-US",
    "name": "Recipient One",
    "updated_at": "2020-07-01T18:00:00Z",
    "user_id": null
  }
}