Wootric

App · 18 actions

Work with your Wootric (InMoment NPS) customer feedback: read the NPS summary, find, add, change and delete end users, list, record and delete their responses and declines, and manage their survey settings.

Actions

ActionWhat it does
Add end userAdd a person to Wootric by email, with your own id and properties, so they can be surveyed or have responses recorded.
Delete declineDelete a recorded decline.
Delete end userMark an end user and their responses for deletion.
Delete responseDelete a response so it no longer counts towards the NPS.
Find end usersList the people Wootric surveys, optionally filtered by email, when they were created or updated, or whether a survey channel is turned off for them.
Get declineGet one decline with its date and the page it happened on.
Get end userGet one end user by Wootric id, email, external id or phone number, with their properties, last response and survey settings.
Get end user survey settingsGet which channels (email, website, mobile app) an end user may be surveyed through.
Get NPS summaryGet the Net Promoter Score for a date range, with how many promoters, passives and detractors answered and the response rates.
Get responseGet one response with its score, comment, tags and date.
List declinesList the times people dismissed the survey, for the whole account or one end user.
List responsesList NPS responses for the whole account or one end user, filtered by date or, for one end user, by promoter, passive or detractor.
List segmentsList the segments Wootric tracks: the end user property names you can break results down by, with their types.
List survey templatesList the account's survey templates with their languages, and which one is the default.
Record declineRecord that an end user dismissed the survey without answering, so Wootric counts it in the response rate.
Record responseRecord an NPS response for an end user: a score from 0 to 10 and optionally their comment.
Update end userChange an end user's email, external id, dates or properties.
Update end user survey settingsTurn survey channels on or off for one end user, or force a survey on their next visit.

Add end user

Add a person to Wootric by email, with your own id and properties, so they can be surveyed or have responses recorded.

Inputs

EmailemailtextRequired
The person's email address.
External IDexternal_idtext
Your own id for this person, such as a customer id.
Last surveyedlast_surveyeddate and time
When this person was last surveyed, if elsewhere.
Customer sinceexternal_created_atdate and time
When this person became your customer or user.
Propertiespropertiesobject
Your own details about the end user to segment results by, such as {"plan": "Pro"}. Keys and values are kept as given.

Outputs

end_userobject
The end user
Example output
{
  "end_user": {
    "created_at": "2026-10-01T09:00:00.000Z",
    "email": "jo@example.com",
    "external_created_at": "2026-01-05T09:00:00.000Z",
    "external_id": "cust-77",
    "id": 4012,
    "last_response": {
      "id": 9001,
      "score": 9,
      "survey": {},
      "text": "Great"
    },
    "last_seen_at": null,
    "last_surveyed": "2026-09-20T09:00:00.000Z",
    "phone_number": null,
    "properties": {
      "plan": "Pro"
    },
    "settings": {
      "email_nps": true,
      "force_mobile_survey": false,
      "force_web_survey": false,
      "mobile_nps": true,
      "surveys_disabled_by_end_user": false,
      "web_nps": true
    },
    "updated_at": "2026-10-01T09:00:00.000Z"
  }
}

Delete decline

Delete a recorded decline.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.
Decline IDdecline_idtextRequired
The decline's id, from 'List declines' or 'Record decline'.

Outputs

decline_idtext
The decline deleted
deletedtrue/false
Always true once deleted
Example output
{
  "decline_id": "3301",
  "deleted": true
}

Delete end user

Mark an end user and their responses for deletion. Wootric removes them at 7 AM UTC the next day.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
end_user_idtext
The end user deleted
Example output
{
  "deleted": true,
  "end_user_id": "4012"
}

Delete response

Delete a response so it no longer counts towards the NPS.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.
Response IDresponse_idtextRequired
The response's id, from 'List responses' or 'Record response'.

Outputs

deletedtrue/false
Always true once deleted
response_idtext
The response deleted
Example output
{
  "deleted": true,
  "response_id": "9001"
}

Find end users

List the people Wootric surveys, optionally filtered by email, when they were created or updated, or whether a survey channel is turned off for them. Gets one page; to see more, run it again with the next page it gives.

Inputs

Emailemailtext
Only the end user with this email address.
Created aftercreated_afterdate and time
Only records created after this date and time.
Created beforecreated_beforedate and time
Only records created before this date and time.
Updated afterupdated_afterdate and time
Only records updated after this date and time.
Updated beforeupdated_beforedate and time
Only records updated before this date and time.
Only people with a survey channel offsurveys_disabledtrue/false
Only end users with at least one survey channel (email, website or mobile app) turned off.
Sort bysort_keytext
What to sort by. Defaults to email.One of: email (Email (default)), created_at (Date created), updated_at (Date updated).
Ordersort_ordertext
Defaults to ascending.One of: asc (Ascending (default)), desc (Descending).
Pagepagenumber
Which page to get, 1 to 30. Defaults to the first.From 1 to 30.
Page sizeper_pagenumber
How many to return per page, 1 to 50. Wootric's default is 25.From 1 to 50.

Outputs

countnumber
How many came back on this page
end_userslist
The end users
next_pagenumber
The page number to ask for next, or 0 when there are no more
pagenumber
The page number returned
Example output
{
  "count": 1,
  "end_users": [
    {
      "created_at": "2026-10-01T09:00:00.000Z",
      "email": "jo@example.com",
      "external_created_at": "2026-01-05T09:00:00.000Z",
      "external_id": "cust-77",
      "id": 4012,
      "last_response": {
        "id": 9001,
        "score": 9,
        "survey": {},
        "text": "Great"
      },
      "last_seen_at": null,
      "last_surveyed": "2026-09-20T09:00:00.000Z",
      "phone_number": null,
      "properties": {
        "plan": "Pro"
      },
      "settings": {
        "email_nps": true,
        "force_mobile_survey": false,
        "force_web_survey": false,
        "mobile_nps": true,
        "surveys_disabled_by_end_user": false,
        "web_nps": true
      },
      "updated_at": "2026-10-01T09:00:00.000Z"
    }
  ],
  "next_page": 0,
  "page": 1
}

Get decline

Get one decline with its date and the page it happened on.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.
Decline IDdecline_idtextRequired
The decline's id, from 'List declines' or 'Record decline'.

Outputs

declineobject
The decline
Example output
{
  "decline": {
    "created_at": "2026-10-02T09:05:00.000Z",
    "end_user": {
      "properties": {
        "plan": "Pro"
      }
    },
    "end_user_id": 4012,
    "id": 3301,
    "ip_address": "203.0.113.5",
    "origin_url": "https://example.com/app",
    "survey_id": 12,
    "updated_at": "2026-10-02T09:05:00.000Z"
  }
}

Get end user

Get one end user by Wootric id, email, external id or phone number, with their properties, last response and survey settings.

Inputs

End useridentifiertextRequired
The end user's Wootric id, email, external id or phone number, matching 'Look up by'. A phone number starts with + and the country code.
Look up bylookup_bytext
What the value above is. Defaults to Wootric's id.One of: id (Wootric ID (default)), email (Email address), external_id (External ID), phone_number (Phone number).

Outputs

end_userobject
The end user
Example output
{
  "end_user": {
    "created_at": "2026-10-01T09:00:00.000Z",
    "email": "jo@example.com",
    "external_created_at": "2026-01-05T09:00:00.000Z",
    "external_id": "cust-77",
    "id": 4012,
    "last_response": {
      "id": 9001,
      "score": 9,
      "survey": {},
      "text": "Great"
    },
    "last_seen_at": null,
    "last_surveyed": "2026-09-20T09:00:00.000Z",
    "phone_number": null,
    "properties": {
      "plan": "Pro"
    },
    "settings": {
      "email_nps": true,
      "force_mobile_survey": false,
      "force_web_survey": false,
      "mobile_nps": true,
      "surveys_disabled_by_end_user": false,
      "web_nps": true
    },
    "updated_at": "2026-10-01T09:00:00.000Z"
  }
}

Get end user survey settings

Get which channels (email, website, mobile app) an end user may be surveyed through.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.

Outputs

settingsobject
The end user's survey settings
Example output
{
  "settings": {
    "created_at": "2026-10-01T09:00:00.000Z",
    "email_nps": true,
    "end_user_id": 4012,
    "force_mobile_survey": false,
    "force_web_survey": false,
    "id": 551,
    "mobile_nps": true,
    "updated_at": "2026-10-01T09:00:00.000Z",
    "web_nps": true
  }
}

Get NPS summary

Get the Net Promoter Score for a date range, with how many promoters, passives and detractors answered and the response rates. Wootric uses the last month when no dates are given.

Inputs

Fromstart_datedate
First day to include. Wootric defaults to the last month.
Untilend_datedate
Last day to include, in your account's time zone.

Outputs

summaryobject
The summary
Example output
{
  "summary": {
    "detractors": 18,
    "email_response_rate": 12.1,
    "nps": 42,
    "passives": 30,
    "promoters": 72,
    "response_rate": 24.5,
    "responses": 120
  }
}

Get response

Get one response with its score, comment, tags and date.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.
Response IDresponse_idtextRequired
The response's id, from 'List responses' or 'Record response'.

Outputs

responseobject
The response
Example output
{
  "response": {
    "completed": true,
    "created_at": "2026-10-01T09:05:00.000Z",
    "end_user": {
      "properties": {
        "plan": "Pro"
      }
    },
    "end_user_id": 4012,
    "excluded_from_calculations": false,
    "id": 9001,
    "ip_address": "203.0.113.5",
    "origin_url": "https://example.com/app",
    "score": 9,
    "survey_id": 12,
    "tags": [
      "pricing"
    ],
    "text": "Great product",
    "updated_at": "2026-10-01T09:05:00.000Z"
  }
}

List declines

List the times people dismissed the survey, for the whole account or one end user. Gets one page; to see more, run it again with the next page it gives.

Inputs

End user IDend_user_idtext
Only this end user's records. Leave empty for the whole account. Wootric's id, from 'Find end users' or an earlier step.
Created aftercreated_afterdate and time
Only records created after this date and time.
Created beforecreated_beforedate and time
Only records created before this date and time.
Updated afterupdated_afterdate and time
Only records updated after this date and time.
Updated beforeupdated_beforedate and time
Only records updated before this date and time.
Sort bysort_keytext
What to sort by. Defaults to the date created.One of: created_at (Date created (default)), updated_at (Date updated).
Ordersort_ordertext
Defaults to newest first.One of: desc (Newest first (default)), asc (Oldest first).
Pagepagenumber
Which page to get, 1 to 30. Defaults to the first.From 1 to 30.
Page sizeper_pagenumber
How many to return per page, 1 to 50. Wootric's default is 25.From 1 to 50.

Outputs

countnumber
How many came back on this page
declineslist
The declines
next_pagenumber
The page number to ask for next, or 0 when there are no more
pagenumber
The page number returned
Example output
{
  "count": 1,
  "declines": [
    {
      "created_at": "2026-10-02T09:05:00.000Z",
      "end_user": {
        "properties": {
          "plan": "Pro"
        }
      },
      "end_user_id": 4012,
      "id": 3301,
      "ip_address": "203.0.113.5",
      "origin_url": "https://example.com/app",
      "survey_id": 12,
      "updated_at": "2026-10-02T09:05:00.000Z"
    }
  ],
  "next_page": 0,
  "page": 1
}

List responses

List NPS responses for the whole account or one end user, filtered by date or, for one end user, by promoter, passive or detractor. Gets one page; to see more, run it again with the next page it gives.

Inputs

End user IDend_user_idtext
Only this end user's records. Leave empty for the whole account. Wootric's id, from 'Find end users' or an earlier step.
Which responsessentimenttext
Split by score: promoters, passives or detractors. Needs an end user ID, since Wootric splits them only for one end user.One of: all (All responses (default)), promoters (Promoters (9 to 10)), passives (Passives (7 to 8)), detractors (Detractors (0 to 6)).
Created aftercreated_afterdate and time
Only records created after this date and time.
Created beforecreated_beforedate and time
Only records created before this date and time.
Updated afterupdated_afterdate and time
Only records updated after this date and time.
Updated beforeupdated_beforedate and time
Only records updated before this date and time.
Sort bysort_keytext
What to sort by. Defaults to the date created.One of: created_at (Date created (default)), updated_at (Date updated).
Ordersort_ordertext
Defaults to newest first.One of: desc (Newest first (default)), asc (Oldest first).
Pagepagenumber
Which page to get, 1 to 30. Defaults to the first.From 1 to 30.
Page sizeper_pagenumber
How many to return per page, 1 to 50. Wootric's default is 25.From 1 to 50.

Outputs

countnumber
How many came back on this page
next_pagenumber
The page number to ask for next, or 0 when there are no more
pagenumber
The page number returned
responseslist
The responses
Example output
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "responses": [
    {
      "completed": true,
      "created_at": "2026-10-01T09:05:00.000Z",
      "end_user": {
        "properties": {
          "plan": "Pro"
        }
      },
      "end_user_id": 4012,
      "excluded_from_calculations": false,
      "id": 9001,
      "ip_address": "203.0.113.5",
      "origin_url": "https://example.com/app",
      "score": 9,
      "survey_id": 12,
      "tags": [
        "pricing"
      ],
      "text": "Great product",
      "updated_at": "2026-10-01T09:05:00.000Z"
    }
  ]
}

List segments

List the segments Wootric tracks: the end user property names you can break results down by, with their types.

Inputs

None.

Outputs

countnumber
How many segments
segmentslist
The segments
Example output
{
  "count": 1,
  "segments": [
    {
      "created_at": "2026-01-05T09:00:00.000Z",
      "data_type": "string",
      "name": "plan"
    }
  ]
}

List survey templates

List the account's survey templates with their languages, and which one is the default.

Inputs

None.

Outputs

countnumber
How many templates
default_survey_template_idnumber
The default template's id, 0 if none
survey_templateslist
The survey templates
Example output
{
  "count": 1,
  "default_survey_template_id": 7,
  "survey_templates": [
    {
      "custom_samplings": {},
      "default_language": "en",
      "id": 7,
      "languages": [
        {
          "code": "en",
          "name": "English"
        }
      ],
      "name": "Default NPS survey",
      "non_configured_language_count": 0
    }
  ]
}

Record decline

Record that an end user dismissed the survey without answering, so Wootric counts it in the response rate.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.
Page addressorigin_urltext
The address of the page the person dismissed the survey on.
Declined atcreated_atdate and time
When the person declined. Defaults to now.
Propertiespropertiesobject
Your own details about the end user to segment results by, such as {"plan": "Pro"}. Keys and values are kept as given.

Outputs

declineobject
The decline
Example output
{
  "decline": {
    "created_at": "2026-10-02T09:05:00.000Z",
    "end_user": {
      "properties": {
        "plan": "Pro"
      }
    },
    "end_user_id": 4012,
    "id": 3301,
    "ip_address": "203.0.113.5",
    "origin_url": "https://example.com/app",
    "survey_id": 12,
    "updated_at": "2026-10-02T09:05:00.000Z"
  }
}

Record response

Record an NPS response for an end user: a score from 0 to 10 and optionally their comment. Use it to bring in answers collected somewhere else.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.
ScorescorenumberRequired
The 0 to 10 likelihood-to-recommend score.From 0 to 10.
Commenttexttext
What the person said about their score.
Page addressorigin_urltextRequired
The address of the page the person answered on.
IP addressip_addresstext
The IP address the response came from.
Answered atcreated_atdate and time
When the person answered. Defaults to now.
Propertiespropertiesobject
Your own details about the end user to segment results by, such as {"plan": "Pro"}. Keys and values are kept as given.

Outputs

responseobject
The response
Example output
{
  "response": {
    "completed": true,
    "created_at": "2026-10-01T09:05:00.000Z",
    "end_user": {
      "properties": {
        "plan": "Pro"
      }
    },
    "end_user_id": 4012,
    "excluded_from_calculations": false,
    "id": 9001,
    "ip_address": "203.0.113.5",
    "origin_url": "https://example.com/app",
    "score": 9,
    "survey_id": 12,
    "tags": [
      "pricing"
    ],
    "text": "Great product",
    "updated_at": "2026-10-01T09:05:00.000Z"
  }
}

Update end user

Change an end user's email, external id, dates or properties. Only the fields given change.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.
Emailemailtext
A new email address. Leave empty to keep it.
External IDexternal_idtext
Your own id for this person, such as a customer id.
Last surveyedlast_surveyeddate and time
When this person was last surveyed, if elsewhere.
Customer sinceexternal_created_atdate and time
When this person became your customer or user.
Propertiespropertiesobject
Your own details about the end user to segment results by, such as {"plan": "Pro"}. Keys and values are kept as given.

Outputs

end_userobject
The end user
Example output
{
  "end_user": {
    "created_at": "2026-10-01T09:00:00.000Z",
    "email": "jo@example.com",
    "external_created_at": "2026-01-05T09:00:00.000Z",
    "external_id": "cust-77",
    "id": 4012,
    "last_response": {
      "id": 9001,
      "score": 9,
      "survey": {},
      "text": "Great"
    },
    "last_seen_at": null,
    "last_surveyed": "2026-09-20T09:00:00.000Z",
    "phone_number": null,
    "properties": {
      "plan": "Pro"
    },
    "settings": {
      "email_nps": true,
      "force_mobile_survey": false,
      "force_web_survey": false,
      "mobile_nps": true,
      "surveys_disabled_by_end_user": false,
      "web_nps": true
    },
    "updated_at": "2026-10-01T09:00:00.000Z"
  }
}

Update end user survey settings

Turn survey channels on or off for one end user, or force a survey on their next visit. Settings left as they are do not change.

Inputs

End user IDend_user_idtextRequired
Wootric's id for the end user, from 'Find end users', 'Add end user' or an earlier step.
Email surveysemail_npstext
Whether this person can be surveyed by email.One of: unchanged (Leave as it is (default)), on, off.
Website surveysweb_npstext
Whether this person can be surveyed on your website.One of: unchanged (Leave as it is (default)), on, off.
Mobile app surveysmobile_npstext
Whether this person can be surveyed in your mobile app.One of: unchanged (Leave as it is (default)), on, off.
Show the website survey next visitforce_web_surveytext
Show the website survey on this person's next visit.One of: unchanged (Leave as it is (default)), on, off.
Show the mobile survey next visitforce_mobile_surveytext
Show the mobile app survey on this person's next visit.One of: unchanged (Leave as it is (default)), on, off.

Outputs

settingsobject
The end user's survey settings
Example output
{
  "settings": {
    "created_at": "2026-10-01T09:00:00.000Z",
    "email_nps": false,
    "end_user_id": 4012,
    "force_mobile_survey": false,
    "force_web_survey": false,
    "id": 551,
    "mobile_nps": true,
    "updated_at": "2026-10-01T09:00:00.000Z",
    "web_nps": true
  }
}

On this page