InMoment
App · 25 actions
Manage InMoment Microsurveys end users, responses, declines, survey preferences and NPS summaries.
Actions
| Action | What it does |
|---|---|
| Create decline | Create decline. |
| Create end user | Create end user. |
| Create response | Create response. |
| Delete decline | Delete decline. |
| Delete end user | Delete end user. |
| Delete response | Delete response. |
| Find end user by email | Find end user by email. |
| Find end user by external id | Find end user by external id. |
| Find end user by phone | Find end user by phone. |
| Get decline | Get decline. |
| Get end user | Get end user. |
| Get end user settings | Get end user settings. |
| Get nps summary | Get nps summary. |
| Get response | Get response. |
| List declines | List declines. |
| List detractors responses | List detractors responses. |
| List end user declines | List end user declines. |
| List end user responses | List end user responses. |
| List end users | List end users. |
| List passives responses | List passives responses. |
| List promoters responses | List promoters responses. |
| List responses | List responses. |
| Update end user | Update end user. |
| Update end user settings | Update end user settings. |
| Update response | Update response. |
Create decline
Create decline.
Inputs
- End user
end_user_idtextRequired - End user id.
- Ip address
ip_addresstextRequired - Ip address.
- Origin url
origin_urltextRequired - Origin url.
- Created at
created_atdate and time - Created at.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"end_user_id": 1,
"id": 1,
"updated_at": "example"
}
}Create end user
Create end user.
Inputs
- Email
emailtextRequired - Email.
- External id
external_idtext - External id.
- Properties
propertiesobject - Properties.
- Last surveyed
last_surveyeddate and time - Last surveyed.
- External created at
external_created_atdate and time - External created at.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"email": "example",
"external_id": "example",
"id": 1,
"properties": {},
"settings": {},
"updated_at": "example"
}
}Create response
Create response.
Inputs
- End user
end_user_idtextRequired - End user id.
- Score
scorenumberRequired - Score.From 0 to 10.
- Ip address
ip_addresstextRequired - Ip address.
- Origin url
origin_urltextRequired - Origin url.
- Text
texttext - Text.
- Created at
created_atdate and time - Created at.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"end_user_id": 1,
"id": 1,
"score": 1,
"text": "example",
"updated_at": "example"
}
}Delete decline
Delete decline.
Inputs
- End user
end_user_idtextRequired - End user id.
- Decline id
decline_idtextRequired - Decline id.
Outputs
dataobject- Result.
Example output
{
"data": {}
}Delete end user
Delete end user.
Inputs
- End user
end_user_idtextRequired - End user id.
Outputs
dataobject- Result.
Example output
{
"data": {}
}Delete response
Delete response.
Inputs
- End user
end_user_idtextRequired - End user id.
- Response id
response_idtextRequired - Response id.
Outputs
dataobject- Result.
Example output
{
"data": {}
}Find end user by email
Find end user by email.
Inputs
- Email
emailtextRequired - Email.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"email": "example",
"external_id": "example",
"id": 1,
"properties": {},
"settings": {},
"updated_at": "example"
}
}Find end user by external id
Find end user by external id.
Inputs
- External id
external_idtextRequired - External id.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"email": "example",
"external_id": "example",
"id": 1,
"properties": {},
"settings": {},
"updated_at": "example"
}
}Find end user by phone
Find end user by phone.
Inputs
- Phone number
phone_numbertextRequired - Phone number.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"email": "example",
"external_id": "example",
"id": 1,
"properties": {},
"settings": {},
"updated_at": "example"
}
}Get decline
Get decline.
Inputs
- End user
end_user_idtextRequired - End user id.
- Decline id
decline_idtextRequired - Decline id.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"end_user_id": 1,
"id": 1,
"updated_at": "example"
}
}Get end user
Get end user.
Inputs
- End user
end_user_idtextRequired - End user id.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"email": "example",
"external_id": "example",
"id": 1,
"properties": {},
"settings": {},
"updated_at": "example"
}
}Get end user settings
Get end user settings.
Inputs
- End user
end_user_idtextRequired - End user id.
Outputs
dataobject- Result.
Example output
{
"data": {
"email_nps": false,
"mobile_nps": false,
"web_nps": false
}
}Get nps summary
Get nps summary.
Inputs
- Start date
start_datedate - Start date.
- End date
end_datedate - End date.
Outputs
dataobject- Result.
Example output
{
"data": {}
}Get response
Get response.
Inputs
- End user
end_user_idtextRequired - End user id.
- Response id
response_idtextRequired - Response id.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"end_user_id": 1,
"id": 1,
"score": 1,
"text": "example",
"updated_at": "example"
}
}List declines
List declines.
Inputs
- Page
pagenumber - Page.From 1 to 30. Default:
1. - Per page
per_pagenumber - Per page.From 1 to 50. Default:
25. - Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
Outputs
datalist- Result.
Example output
{
"data": []
}List detractors responses
List detractors responses.
Inputs
- End user
end_user_idtextRequired - End user id.
- Page
pagenumber - Page.From 1 to 30. Default:
1. - Per page
per_pagenumber - Per page.From 1 to 50. Default:
25. - Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
Outputs
datalist- Result.
Example output
{
"data": []
}List end user declines
List end user declines.
Inputs
- End user
end_user_idtextRequired - End user id.
- Page
pagenumber - Page.From 1 to 30. Default:
1. - Per page
per_pagenumber - Per page.From 1 to 50. Default:
25. - Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
Outputs
datalist- Result.
Example output
{
"data": []
}List end user responses
List end user responses.
Inputs
- End user
end_user_idtextRequired - End user id.
- Page
pagenumber - Page.From 1 to 30. Default:
1. - Per page
per_pagenumber - Per page.From 1 to 50. Default:
25. - Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
Outputs
datalist- Result.
Example output
{
"data": []
}List end users
List end users.
Inputs
- Page
pagenumber - Page.From 1 to 30. Default:
1. - Per page
per_pagenumber - Per page.From 1 to 50. Default:
25. - Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
- Email
emailtext - Email.
- Sort order
sort_ordertext - Sort order.One of:
asc,desc. - Sort key
sort_keytext - Sort key.One of:
email,updated_at(Updated at),created_at(Created at). - Surveys disabled
surveys_disabledtrue/false - Surveys disabled.
Outputs
datalist- Result.
Example output
{
"data": []
}List passives responses
List passives responses.
Inputs
- End user
end_user_idtextRequired - End user id.
- Page
pagenumber - Page.From 1 to 30. Default:
1. - Per page
per_pagenumber - Per page.From 1 to 50. Default:
25. - Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
Outputs
datalist- Result.
Example output
{
"data": []
}List promoters responses
List promoters responses.
Inputs
- End user
end_user_idtextRequired - End user id.
- Page
pagenumber - Page.From 1 to 30. Default:
1. - Per page
per_pagenumber - Per page.From 1 to 50. Default:
25. - Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
Outputs
datalist- Result.
Example output
{
"data": []
}List responses
List responses.
Inputs
- Page
pagenumber - Page.From 1 to 30. Default:
1. - Per page
per_pagenumber - Per page.From 1 to 50. Default:
25. - Created after
created_afterdate and time - Created after.
- Created before
created_beforedate and time - Created before.
Outputs
datalist- Result.
Example output
{
"data": []
}Update end user
Update end user.
Inputs
- End user
end_user_idtextRequired - End user id.
- Email
emailtext - Email.
- External id
external_idtext - External id.
- Properties
propertiesobject - Properties.
- Last surveyed
last_surveyeddate and time - Last surveyed.
- External created at
external_created_atdate and time - External created at.
Outputs
dataobject- Result.
Example output
{
"data": {
"created_at": "example",
"email": "example",
"external_id": "example",
"id": 1,
"properties": {},
"settings": {},
"updated_at": "example"
}
}Update end user settings
Update end user settings.
Inputs
- End user
end_user_idtextRequired - End user id.
- Email nps
email_npstrue/false - Email nps.
- Mobile nps
mobile_npstrue/false - Mobile nps.
- Web nps
web_npstrue/false - Web nps.
Outputs
dataobject- Result.
Example output
{
"data": {}
}Update response
Update response.
Inputs
- Response id
response_idtextRequired - Response id.
- Completed
completedtrue/false - Completed.
- Excluded from calculations
excluded_from_calculationstrue/false - Excluded from calculations.
Outputs
dataobject- Result.
Example output
{
"data": {}
}