{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/users/:alias","auth":"required","examples":{"codes":[{"name":"","language":"shell","code":"curl -X PUT \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/users/$ALIAS\"\n  -H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"\n  -d '{\n      \"user\": {\n        \"custom_attributes\": [\n          {\n            \"name\": \"gender\",\n            \"value\": \"male\",\n            \"type\": \"String\",\n            \"action\": \"Update\"\n          }\t\n        ]\n      }\n  }'"}]},"method":"put","params":[{"name":"app_id","type":"string","default":"","desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"57ff831b159c7e0e003c4827"},{"name":"alias","type":"string","default":"","desc":"User unique alias within the App. Should only contain the following characters 1-9, A-Z and !:::at:::$^&*()_+=-{}[]:\"'<>,|","required":true,"in":"path","ref":"","_id":"587767d6e3deb13100cbcbd1"},{"name":"user","type":"array_object","default":"alias","desc":"Attribtues to be updated","required":true,"in":"body","ref":"","_id":"564bbf454bf5c80d0020901f"},{"name":"user[].name","type":"string","default":"","desc":"User attribute name","required":false,"in":"body","ref":"","_id":"587767d6e3deb13100cbcbd0"},{"name":"user[custom_attributes]","type":"array_object","default":"","desc":"User custom attributes Array","required":false,"in":"body","ref":"","_id":"5c5c25dcae28c300620290ca"},{"name":"user[custom_attributes][0].value","type":"string","default":"","desc":"User attribute value","required":false,"in":"body","ref":"","_id":"587767d6e3deb13100cbcbcf"},{"name":"user[custom_attributes][0].type","type":"string","default":"","desc":"User attribute type, can be one of: ['Boolean', 'Date', 'Float', 'Integer', 'Numeric', 'String']","required":false,"in":"body","ref":"","_id":"587767d6e3deb13100cbcbce"},{"name":"user[custom_attributes][0].action","type":"string","default":"","desc":"Action to be performed, can be one of: ['Decrement', 'Increment', 'Update']","required":false,"in":"body","ref":"","_id":"587767d6e3deb13100cbcbcd"}],"results":{"codes":[{"name":"","code":"{\n    \"age\": null,\n    \"alias\": \"447700770000\",\n    \"current_city\": \"Dublin\",\n    \"current_country\": \"Ireland\",\n    \"current_location\": [\n        -6.3899571,\n        53.4037500\n    ],\n    \"email\": \"\",\n    \"firstName\": \"John\",\n\t\t\"lastName\": \"Smith\",\n    \"first_session_at\": \"2020-08-04T15:56:17+00:00\",\n    \"gender\": \"male\",\n    \"last_session_at\": \"2020-08-04T20:14:28+00:00\",\n    \"location_tracking_enabled\": true,\n    \"phone\": \"+35386000000\",\n    \"sessions_created\": 7,\n    \"status\": \"active\",\n    \"devices\": [\n        {\n            \"active\": true,\n            \"uninstalled\": false,\n            \"guid\": \"9da856f1-491b-b179-5fe7-1167cb3c96ba\",\n            \"type\": \"android\",\n            \"app_version\": \"3.3.3-beta\",\n            \"os_version\": \"10\",\n            \"sdk_version\": \"3.3.3\",\n            \"timezone\": \"GMT\",\n            \"language\": \"en\",\n            \"location_permission\": true,\n            \"push_permission\": true\n        },\n        {\n            \"active\": true,\n            \"uninstalled\": false,\n            \"guid\": \"a814c08e-9334-eb56-4fb7-1386814e86e2\",\n            \"type\": \"android\",\n            \"app_version\": \"3.3.3-beta\",\n            \"os_version\": \"10\",\n            \"sdk_version\": \"3.3.3\",\n            \"timezone\": \"GMT\",\n            \"language\": \"en\",\n            \"location_permission\": true,\n            \"push_permission\": true\n        }\n    ],\n    \"push_preferences\": {\n        \"opt_out\": false\n    },\n    \"id\": \"3b9075f29852d34101206970\"\n}","language":"json","status":200},{"code":"","language":"text"}]},"settings":"564bbbf80cbcc91700b8171c"},"next":{"description":"","pages":[]},"title":"Users: Update One","type":"endpoint","slug":"users-update-one","excerpt":"","body":"","updates":[],"order":64,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28ce","version":{"version":"2.2","version_clean":"2.2.0","codename":"CMS API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e4fced159815700262d2899","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e4fced159815700262d289a","5e4fced159815700262d289b","5e4fced159815700262d289c","5e4fced159815700262d289d","5e4fced159815700262d289e","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e4fced159815700262d289f","5e4fced159815700262d28a0","5c73dd27e8fdc000572a206a","5e4fced159815700262d28a1","5e53c04c1d11110018b56e12"],"_id":"5e4fced159815700262d2930","project":"54aa7f773b56130b0056c86e","forked_from":"55781fe25129590d003ff4f7","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"},"githubsync":"","parentDoc":null,"editedParams2":true,"project":"54aa7f773b56130b0056c86e","user":"54aa7f3f9bb00c0b00cb899b","editedParams":true,"__v":11,"category":{"sync":{"isSync":false,"url":""},"pages":["5e4fced159815700262d28c6","5e4fced159815700262d28c7","5e4fced159815700262d28c8","5e4fced159815700262d28c9","5e4fced159815700262d28ca","5e4fced159815700262d28cb","5e4fced159815700262d28cc","5e4fced159815700262d28cd","5e4fced159815700262d28ce","564c68a93eb8f81700838a25"],"title":"Pulsate CMS API","slug":"pulsate-cms-api","order":1,"from_sync":false,"reference":true,"_id":"5e4fced159815700262d289e","__v":10,"createdAt":"2015-11-17T23:47:10.058Z","project":"54aa7f773b56130b0056c86e","version":"5e4fced159815700262d2930"},"createdAt":"2015-11-18T11:21:22.432Z"}

putUsers: Update One


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.
alias:
required
string
User unique alias within the App. Should only contain the following characters 1-9, A-Z and [email protected]$^&*()_+=-{}[]:"'<>,|

Body Params

user:
required
array of objectsalias
Attribtues to be updated
user[].name:
string
User attribute name
user[custom_attributes]:
array of objects
User custom attributes Array
user[custom_attributes][0].value:
string
User attribute value
user[custom_attributes][0].type:
string
User attribute type, can be one of: ['Boolean', 'Date', 'Float', 'Integer', 'Numeric', 'String']
user[custom_attributes][0].action:
string
Action to be performed, can be one of: ['Decrement', 'Increment', 'Update']

Examples


Result Format


User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}