{"_id":"55fa463317b9d00d00969ead","category":{"_id":"55fa37ca8065a10d004e5bb8","pages":["55fa37cb8065a10d004e5bc5","55fa37cb8065a10d004e5bc6","55fa37cb8065a10d004e5bc7","55fa37cb8065a10d004e5bc8","55fa37cb8065a10d004e5bc9","55fa37cb8065a10d004e5bca","55fa37cb8065a10d004e5bcb","55fa37cb8065a10d004e5bcc","55fa37cb8065a10d004e5bcd","55fa3dd4a663c00d00773dd1","55fa409d8065a10d004e5bda","55fa463317b9d00d00969ead","55fa4822764f5021009506c0","55fa4bfeaba81f0d00a115e7","55fa4dcd17b9d00d00969eb7","55fca6ccf95c5b0d0068fdfa","55fe6735748eb30d008a1e61","55ff4d91cc468e0d008dce5f","55ff558a9e7ccf0d000a1d49","55ff5695cc468e0d008dce67","55ff6e986932a00d00ba7a37","55ff702f9e7ccf0d000a1d83","560221271ba3720d00a6b99d","560221418a6c97170066cf48","563e18aad6db8d17008389ac"],"version":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":17,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-06T05:42:37.534Z","from_sync":false,"order":3,"slug":"users","title":"Users"},"parentDoc":null,"project":"54e405191e51932d006abc39","__v":9,"editedParams":true,"version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":9,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["55fa37ca8065a10d004e5bb7","55fa37ca8065a10d004e5bb8","55fa37ca8065a10d004e5bb9","55fa37ca8065a10d004e5bba","55fca6bf34ae7c0d00ab8ea0","55ff80fd9e7ccf0d000a1d93","560220af7435de0d00fabd0d","56107f21bb9d920d00303e70","563e184077681a0d00d96a02","56fafc6596ec7e0e002ac85f","5915e54f7c2c552d008b8549","59499fcd64b5f5002690bbc1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"editedParams2":true,"user":"54e4044e8ef7552300409dcb","updates":["560847ab99ba842300101cad","560e0e3859cb8d0d0015cc98"],"next":{"pages":[],"description":""},"createdAt":"2015-09-17T04:48:51.398Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"PATCH /v3.1/users/594e0fa2838454002ea317a0 HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-GATEWAY: client_id_2bb1e412edd311e6bd04e285d6015267|client_secret_2bb1e714edd311e6bd04e285d6015267\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_1mtgLwhYHDVKop04XOEjyWJSsnQqZbGkfRF5ux9v|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\n\n{\n  \"update\":{\n    \"login\":{\n      \"email\":\"test2:::at:::synapsepay.com\"\n    },\n    \"remove_login\":{\n      \"email\":\"test@synapsepay.com\"\n    },\n    \"phone_number\":\"901-111-2222\",\n    \"remove_phone_number\":\"901.111.1111\"\n    }\n}","language":"http"}]},"method":"patch","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"_id\": \"594e0fa2838454002ea317a0\",\n    \"_links\": {\n        \"self\": {\n            \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0\"\n        }\n    },\n    \"client\": {\n        \"id\": \"589acd9ecb3cd400fa75ac06\",\n        \"name\": \"SynapseFI\"\n    },\n    \"doc_status\": {\n        \"physical_doc\": \"SUBMITTED|VALID\",\n        \"virtual_doc\": \"SUBMITTED|VALID\"\n    },\n    \"documents\": [\n        {\n            \"id\": \"d02f580c1335a625ab2da2d7e53472d4e7fd664e633387654ebebe15ea696c91\",\n            \"name\": \"Test User\",\n            \"permission_scope\": \"SEND|RECEIVE|1000|DAILY\",\n            \"physical_docs\": [\n                {\n                    \"document_type\": \"GOVT_ID\",\n                    \"id\": \"70e3f32d8feba746347b5c0d820e8d7a218b955afbb612291a0a9922c93e8277\",\n                    \"last_updated\": 1498289173417,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"social_docs\": [\n                {\n                    \"document_type\": \"PHONE_NUMBER\",\n                    \"id\": \"fda60784d6375bc44edafaaeae149626c4c13dcb92e85a2a7a00eec2cdfd2b6f\",\n                    \"last_updated\": 1498289173420,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"FACEBOOK\",\n                    \"id\": \"8f314a6a53f36ee569455761e49a2a7fe790d251c5611c65255befdb303602b7\",\n                    \"last_updated\": 1498289173420,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"EMAIL\",\n                    \"id\": \"2c45158f6431ca874bbe82f63d5905567854dde4d8b81539944e5779e5eee741\",\n                    \"last_updated\": 1498289173420,\n                    \"status\": \"SUBMITTED|VALID\"\n                },\n                {\n                    \"document_type\": \"IP\",\n                    \"id\": \"28d9177b22c127d9a51d8903893864accf6e553ac326704a4c0d585eaad2516a\",\n                    \"last_updated\": 1498289173420,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ],\n            \"virtual_docs\": [\n                {\n                    \"document_type\": \"SSN\",\n                    \"id\": \"ee596c2896dddc19b76c07a184fe7d3cf5a04b8e94b9108190cac7890739017f\",\n                    \"last_updated\": 1498289173414,\n                    \"status\": \"SUBMITTED|VALID\"\n                }\n            ]\n        }\n    ],\n    \"emails\": [],\n    \"extra\": {\n        \"cip_tag\": 1,\n        \"date_joined\": 1498288029784,\n        \"extra_security\": false,\n        \"is_business\": false,\n        \"last_updated\": 1498289557754,\n        \"public_note\": null,\n        \"supp_id\": \"122eddfgbeafrfvbbb\"\n    },\n    \"is_hidden\": false,\n    \"legal_names\": [\n        \"Test User\"\n    ],\n    \"logins\": [\n        {\n            \"email\": \"test2@synapsepay.com\",\n            \"scope\": \"READ_AND_WRITE\"\n        }\n    ],\n    \"permission\": \"SEND-AND-RECEIVE\",\n    \"phone_numbers\": [\n        \"test@synapsepay.com\",\n        \"901-111-2222\"\n    ],\n    \"photos\": [],\n    \"refresh_token\": \"refresh_ehG7YBS8ZiD0sLa6PQHMUxryovVkJzElC5gWROXq\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":false,"desc":"User's refresh_token","default":"","type":"string","name":"refresh_token"},{"_id":"55fa463317b9d00d00969eb1","ref":"","in":"body","required":false,"desc":"Updated legal name of the user","default":"","type":"string","name":"update.legal_name"},{"_id":"55728c20e42c040d00d68a9f","ref":"","in":"body","required":false,"desc":"Updated login email of the user","default":"","type":"string","name":"update.login.email"},{"_id":"55fa3f2a17b9d00d00969ea5","ref":"","in":"body","required":false,"desc":"Updated login password of the user","default":"","type":"string","name":"update.login.password"},{"_id":"55fa3f2a17b9d00d00969ea4","ref":"","in":"body","required":false,"desc":"If this is a read-only user or an admin user. By default all users added via this API call are admin users","default":"","type":"boolean","name":"update.login.read_only"},{"_id":"55fa463317b9d00d00969eb0","ref":"","in":"body","required":false,"desc":"Updated phone number of the user","default":"","type":"string","name":"update.phone_number"},{"_id":"55fa463317b9d00d00969eaf","ref":"","in":"body","required":false,"desc":"Login email that you wish to remove","default":"","type":"string","name":"update.remove_login.email"},{"_id":"55fa463317b9d00d00969eae","ref":"","in":"body","required":false,"desc":"Phone number that you wish to remove","default":"","type":"string","name":"update.remove_phone_number"},{"_id":"58ca1de5fa6c4b0f0031c111","ref":"","in":"body","required":false,"desc":"Legal name that you wish to remove","default":"","type":"string","name":"update.remove_legal_name"},{"_id":"575f857eaf3e090e00107efb","ref":"","in":"body","required":false,"desc":"Updated CIP tag of the user","default":"","type":"int","name":"update.cip_tag"},{"_id":"5879623ccd4a9c37007c96ed","ref":"","in":"body","required":false,"desc":"Value denotes if the user can be searched by email/name on Synapse services","default":"","type":"boolean","name":"update.is_hidden"},{"_id":"594e0930cf1931003901038b","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to add documents to","default":"","type":"string","name":"user_id"},{"_id":"594e15178564f2004b6b1124","ref":"","in":"body","required":false,"desc":"Any note that you wish to attach to the user (returned with user object)","default":"","type":"string","name":"update.public_note"}],"url":"/v3.1/users/:user_id"},"isReference":true,"order":10,"body":"","excerpt":"This API call lets you update the user information and also get back the update oauth_key and refresh_token","slug":"update-user","type":"endpoint","title":"Update User"}

patchUpdate User

This API call lets you update the user information and also get back the update oauth_key and refresh_token

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

user_id:
required
string
The user ID of the user you wish to add documents to

Body Params

refresh_token:
string
User's refresh_token
update.legal_name:
string
Updated legal name of the user
update.login.email:
string
Updated login email of the user
update.login.password:
string
Updated login password of the user
update.login.read_only:
boolean
If this is a read-only user or an admin user. By default all users added via this API call are admin users
update.phone_number:
string
Updated phone number of the user
update.remove_login.email:
string
Login email that you wish to remove
update.remove_phone_number:
string
Phone number that you wish to remove
update.remove_legal_name:
string
Legal name that you wish to remove
update.cip_tag:
integer
Updated CIP tag of the user
update.is_hidden:
boolean
Value denotes if the user can be searched by email/name on Synapse services
update.public_note:
string
Any note that you wish to attach to the user (returned with user object)

Examples


Result Format