InMoment

App · 25 actions

Manage InMoment Microsurveys end users, responses, declines, survey preferences and NPS summaries.

Actions

ActionWhat it does
Create declineCreate decline.
Create end userCreate end user.
Create responseCreate response.
Delete declineDelete decline.
Delete end userDelete end user.
Delete responseDelete response.
Find end user by emailFind end user by email.
Find end user by external idFind end user by external id.
Find end user by phoneFind end user by phone.
Get declineGet decline.
Get end userGet end user.
Get end user settingsGet end user settings.
Get nps summaryGet nps summary.
Get responseGet response.
List declinesList declines.
List detractors responsesList detractors responses.
List end user declinesList end user declines.
List end user responsesList end user responses.
List end usersList end users.
List passives responsesList passives responses.
List promoters responsesList promoters responses.
List responsesList responses.
Update end userUpdate end user.
Update end user settingsUpdate end user settings.
Update responseUpdate response.

Create decline

Create decline.

Inputs

End userend_user_idtextRequired
End user id.
Ip addressip_addresstextRequired
Ip address.
Origin urlorigin_urltextRequired
Origin url.
Created atcreated_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

EmailemailtextRequired
Email.
External idexternal_idtext
External id.
Propertiespropertiesobject
Properties.
Last surveyedlast_surveyeddate and time
Last surveyed.
External created atexternal_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 userend_user_idtextRequired
End user id.
ScorescorenumberRequired
Score.From 0 to 10.
Ip addressip_addresstextRequired
Ip address.
Origin urlorigin_urltextRequired
Origin url.
Texttexttext
Text.
Created atcreated_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 userend_user_idtextRequired
End user id.
Decline iddecline_idtextRequired
Decline id.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Delete end user

Delete end user.

Inputs

End userend_user_idtextRequired
End user id.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Delete response

Delete response.

Inputs

End userend_user_idtextRequired
End user id.
Response idresponse_idtextRequired
Response id.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Find end user by email

Find end user by email.

Inputs

EmailemailtextRequired
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 idexternal_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 numberphone_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 userend_user_idtextRequired
End user id.
Decline iddecline_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 userend_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 userend_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 datestart_datedate
Start date.
End dateend_datedate
End date.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Get response

Get response.

Inputs

End userend_user_idtextRequired
End user id.
Response idresponse_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

Pagepagenumber
Page.From 1 to 30. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 25.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List detractors responses

List detractors responses.

Inputs

End userend_user_idtextRequired
End user id.
Pagepagenumber
Page.From 1 to 30. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 25.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List end user declines

List end user declines.

Inputs

End userend_user_idtextRequired
End user id.
Pagepagenumber
Page.From 1 to 30. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 25.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List end user responses

List end user responses.

Inputs

End userend_user_idtextRequired
End user id.
Pagepagenumber
Page.From 1 to 30. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 25.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List end users

List end users.

Inputs

Pagepagenumber
Page.From 1 to 30. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 25.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.
Emailemailtext
Email.
Sort ordersort_ordertext
Sort order.One of: asc, desc.
Sort keysort_keytext
Sort key.One of: email, updated_at (Updated at), created_at (Created at).
Surveys disabledsurveys_disabledtrue/false
Surveys disabled.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List passives responses

List passives responses.

Inputs

End userend_user_idtextRequired
End user id.
Pagepagenumber
Page.From 1 to 30. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 25.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List promoters responses

List promoters responses.

Inputs

End userend_user_idtextRequired
End user id.
Pagepagenumber
Page.From 1 to 30. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 25.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.

Outputs

datalist
Result.
Example output
{
  "data": []
}

List responses

List responses.

Inputs

Pagepagenumber
Page.From 1 to 30. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 25.
Created aftercreated_afterdate and time
Created after.
Created beforecreated_beforedate and time
Created before.

Outputs

datalist
Result.
Example output
{
  "data": []
}

Update end user

Update end user.

Inputs

End userend_user_idtextRequired
End user id.
Emailemailtext
Email.
External idexternal_idtext
External id.
Propertiespropertiesobject
Properties.
Last surveyedlast_surveyeddate and time
Last surveyed.
External created atexternal_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 userend_user_idtextRequired
End user id.
Email npsemail_npstrue/false
Email nps.
Mobile npsmobile_npstrue/false
Mobile nps.
Web npsweb_npstrue/false
Web nps.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

Update response

Update response.

Inputs

Response idresponse_idtextRequired
Response id.
Completedcompletedtrue/false
Completed.
Excluded from calculationsexcluded_from_calculationstrue/false
Excluded from calculations.

Outputs

dataobject
Result.
Example output
{
  "data": {}
}

On this page