{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","params":[],"examples":{"codes":[]},"method":"delete"},"next":{"description":"","pages":[]},"title":"Delete User","type":"endpoint","slug":"delete-user-api","excerpt":"","body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/cp/user/<userId></span>\n\n<hr>\n\n##Documentation\n\nThe BlueSnap Delete User API is a RESTful web service that enables you to delete an existing user associated with your account or \"on-behalf\" of a separate but linked BlueSnap account. \n\n##Examples\n\n###Request Example\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Note:\",\n \"body\": \"If you need to manage an operation on behalf of a linked BlueSnap account, use the \\\"onbehalfofmid\\\" parameter.\"\n}\n[/block]\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X DELETE https://sandbox.bluesnap.com/services/2/cp/user/23645623\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n \"language\": \"curl\",\n \"name\": \"Delete User\"\n },\n {\n \"code\": \"curl -v -X DELETE https://sandbox.bluesnap.com/services/2/cp/user/23645623?onbehalfofmid=34234\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n \"language\": \"curl\",\n \"name\": \"Delete User on behalf of linked BlueSnap account\"\n }\n ]\n}\n[/block]\n###Response Example\n\nIf successful, the response HTTP status code is 200 OK.\n\n##Example Descriptions\n\nFor details about the above examples, see:\n\n* [Delete User](https://developers.bluesnap.com/v8976-Tools/docs/delete-user-api#section-delete-user)\n* [Delete User on behalf of linked BlueSnap account](https://developers.bluesnap.com/v8976-Tools/docs/delete-user-api#section-delete-user-on-behalf-of-linked-bluesnap-account)\n\n###Delete User\nThis example shows a Delete User request.\n\n###Delete User on behalf of linked BlueSnap account\nThis example shows a Delete User request on behalf of a linked BlueSnap account.\n\n###Parameter Reference\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Description\",\n \"0-1\": \"Creates, updates, retrieves, or deletes users on behalf of a linked BlueSnap account\\n\\n**Note:** This parameter specifies the ID of the BlueSnap account that owns the user, which should be linked to the BlueSnap account executing the call.\",\n \"0-0\": \"onbehalfofmid\"\n },\n \"cols\": 2,\n \"rows\": 1\n}\n[/block]","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6019bc72944282005e966fa4","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"Test release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6019bc72944282005e966f62","6019bc72944282005e966f63","6019bc72944282005e966f64","6019bc72944282005e966f65","6019bc72944282005e966f66","6019bc72944282005e966f67","6019bc72944282005e966f68","6019bc72944282005e966f69","6019bc72944282005e966f6a","6019bc72944282005e966f6b","6019bc72944282005e966f6c","6019bc72944282005e966f6d","5b34c737e0dca2000311de6a","6019bc72944282005e966f6e","6019bc72944282005e966f6f","6019bc72944282005e966f70","6019bc72944282005e966f71","6019bc72944282005e966f72","6019bc72944282005e966f73","6019bc72944282005e966f74"],"_id":"6019bc72944282005e966fd4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fa1893ed2a2370028d24282","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"User Management","slug":"merchant-single-signon","order":17,"from_sync":false,"reference":false,"_id":"6019bc72944282005e966f6d","project":"57336fd5a6a9c40e00e13a0b","version":"6019bc72944282005e966fd4","createdAt":"2018-06-18T14:13:01.902Z","__v":0},"user":"5b155c2c3fbcd30003e76908","createdAt":"2018-06-18T14:14:51.144Z","githubsync":"","__v":46,"parentDoc":null}
deleteDelete User
Note:
If you need to manage an operation on behalf of a linked BlueSnap account, use the "onbehalfofmid" parameter.
curl -v -X DELETE https://sandbox.bluesnap.com/services/2/cp/user/23645623
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
curl -v -X DELETE https://sandbox.bluesnap.com/services/2/cp/user/23645623?onbehalfofmid=34234
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
Response Example
If successful, the response HTTP status code is 200 OK.
Example Descriptions
For details about the above examples, see:
Delete User
This example shows a Delete User request.
Delete User on behalf of linked BlueSnap account
This example shows a Delete User request on behalf of a linked BlueSnap account.
Parameter Reference
Parameter
Description
onbehalfofmid
Creates, updates, retrieves, or deletes users on behalf of a linked BlueSnap account
Note: This parameter specifies the ID of the BlueSnap account that owns the user, which should be linked to the BlueSnap account executing the call.