{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/users","auth":"required","settings":"564bbbf80cbcc91700b8171c","examples":{"codes":[{"name":"","code":"      curl -X GET \"https://control.pulsatehq.com/api/v1/apps/:app_id/users\" \n      -H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"\n      -d '{\n            \"user\": {\n                \"alias\": \"Mr Terminator \",\n                \"email\": \"test:::at:::test.com\",\n                \"age\": 39,\n                \"device\": {\n                    \"type\": \"android\",\n                    \"token\": \"this-is-token\",\n                    \"os_version\": \"15.09\"\n                },\n                \"gender\": \"man\",\n                \"custom_tags\": [\n                    {\n                        \"key\": \"keykey\",\n                        \"value\": \"this is value\",\n                        \"type\": \"String\",\n                        \"action\": \"update\"\n                    }\n                ]\n            }\n        }'","language":"shell"}]},"method":"post","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":"57ff8306159c7e0e003c4826"},{"name":"user","type":"object","default":"","desc":"User to be created","required":true,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b21c"},{"name":"user[].alias","type":"string","default":"","desc":"user alias","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b21b"},{"name":"user[].email","type":"string","default":"","desc":"users email","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b21a"},{"name":"user[].firstName","type":"string","default":"","desc":"users first name","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b219"},{"name":"user[].lastName","type":"string","default":"","desc":"users last name","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b218"},{"name":"user[].phone","type":"string","default":"","desc":"users phone number","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b217"},{"name":"user[].age","type":"string","default":"","desc":"users age","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b216"},{"name":"users[].gender","type":"string","default":"","desc":"users gender , can be one of: ['man', 'woman']","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b215"},{"name":"user[device]","type":"object","default":"","desc":"users device details","required":true,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b214"},{"name":"user[device][type]","type":"string","default":"","desc":"device type, can be one of: ['ios', 'android']","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b213"},{"name":"user[device][token]","type":"string","default":"","desc":"device token","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b212"},{"name":"user[device][bluetooth_state]","type":"string","default":"","desc":"device bluetooth_state, can be one of: ['on', 'off']","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b211"},{"name":"user[device][os_version]","type":"string","default":"","desc":"device os version","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b210"},{"name":"user[device][sdk_version]","type":"string","default":"","desc":"device sdk version","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b20f"},{"name":"user[device][app_version]","type":"string","default":"","desc":"device app version","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b20e"},{"name":"user[device][timezone]","type":"string","default":"","desc":"device timezone name [CET Europe/Warsaw]","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b20d"},{"name":"user[device][language]","type":"string","default":"","desc":"device language (ISO 639-1 format)","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b20c"},{"name":"user[device][location_permission]","type":"boolean","default":"","desc":"device location permission flag [true/false]","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b20b"},{"name":"user[device][push_permission]","type":"boolean","default":"","desc":"device push permission flag [true/false]","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b20a"},{"name":"user[custom_tags]","type":"array_object","default":"","desc":"user custom tags","required":false,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b209"},{"name":"user[custom_tags][key]","type":"string","default":"","desc":"key of custom param to create","required":true,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b208"},{"name":"user[custom_tags][value]","type":"object","default":"","desc":"value of custom param to create","required":true,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b207"},{"name":"user[custom_tags][type]","type":"string","default":"","desc":"type of the custom tag, can be one of: ['Integer', 'Float', 'String', 'Date', 'Boolean']","required":true,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b206"},{"name":"user[custom_tags][action]","type":"string","default":"","desc":"type of custom param, can be one of: ['increment', 'decrement', 'update']","required":true,"in":"body","ref":"","_id":"5fd200ad35bc2c006486b205"}],"results":{"codes":[{"name":"","code":"{\n    \"age\": 39,\n    \"alias\": \"Mr Terminator \",\n    \"current_city\": \"\",\n    \"current_country\": \"\",\n    \"current_location\": null,\n    \"email\": \"[email protected]\",\n    \"firstName\": null,\n    \"first_session_at\": null,\n    \"gender\": \"man\",\n    \"keykey\": \"this is value\",\n    \"lastName\": null,\n    \"last_session_at\": null,\n    \"location_tracking_enabled\": true,\n    \"phone\": null,\n    \"sessions_created\": 0,\n    \"status\": \"active\",\n    \"devices\": [\n        {\n            \"active\": false,\n            \"uninstalled\": false,\n            \"guid\": null,\n            \"type\": \"android\",\n            \"app_version\": null,\n            \"os_version\": \"15.09\",\n            \"sdk_version\": null,\n            \"timezone\": null,\n            \"language\": null,\n            \"location_permission\": false,\n            \"push_permission\": false\n        }\n    ],\n    \"push_preferences\": {\n        \"opt_out\": false\n    },\n    \"id\": \"5fd20123536b793bdd090000\"\n}","language":"json","status":200}]}},"next":{"description":"","pages":[]},"title":"Users: Create One","type":"endpoint","slug":"users-create-one","excerpt":"","body":"","updates":[],"order":999,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5fd200ad35bc2c006486b204","createdAt":"2020-12-10T11:04:13.020Z","user":"5ecd35a9c7e51000122c9a50","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"},"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"},"project":"54aa7f773b56130b0056c86e","__v":2}

postUsers: Create 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.

Body Params

user:
required
object
User to be created
user[].alias:
string
user alias
user[].email:
string
users email
user[].firstName:
string
users first name
user[].lastName:
string
users last name
user[].phone:
string
users phone number
user[].age:
string
users age
users[].gender:
string
users gender , can be one of: ['man', 'woman']
user[device]:
required
object
users device details
user[device][type]:
string
device type, can be one of: ['ios', 'android']
user[device][token]:
string
device token
user[device][bluetooth_state]:
string
device bluetooth_state, can be one of: ['on', 'off']
user[device][os_version]:
string
device os version
user[device][sdk_version]:
string
device sdk version
user[device][app_version]:
string
device app version
user[device][timezone]:
string
device timezone name [CET Europe/Warsaw]
user[device][language]:
string
device language (ISO 639-1 format)
user[device][location_permission]:
boolean
device location permission flag [true/false]
user[device][push_permission]:
boolean
device push permission flag [true/false]
user[custom_tags]:
array of objects
user custom tags
user[custom_tags][key]:
required
string
key of custom param to create
user[custom_tags][value]:
required
object
value of custom param to create
user[custom_tags][type]:
required
string
type of the custom tag, can be one of: ['Integer', 'Float', 'String', 'Date', 'Boolean']
user[custom_tags][action]:
required
string
type of custom param, can be one of: ['increment', 'decrement', 'update']

Examples


Result Format


User Information

Try It Out

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