{"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":"5ecfffa62b00c0001886625a","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.34.0 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ecfffa62b00c0001886621c","5ecfffa62b00c0001886621d","5ecfffa62b00c0001886621e","5ecfffa62b00c0001886621f","5ecfffa62b00c00018866220","5ecfffa62b00c00018866221","5ecfffa62b00c00018866222","5ecfffa62b00c00018866223","5ecfffa62b00c00018866224","5ecfffa62b00c00018866225","5ecfffa62b00c00018866226","5ecfffa62b00c00018866227","5b34c737e0dca2000311de6a","5ecfffa62b00c00018866228","5ecfffa62b00c00018866229","5ecfffa62b00c0001886622a"],"_id":"5ecfffa62b00c0001886626b","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5e5d3a6a50180a007203a5d0","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":12,"from_sync":false,"reference":false,"_id":"5ecfffa62b00c00018866227","project":"57336fd5a6a9c40e00e13a0b","version":"5ecfffa62b00c0001886626b","createdAt":"2018-06-18T14:13:01.902Z","__v":0},"user":"5b155c2c3fbcd30003e76908","createdAt":"2018-06-18T14:14:51.144Z","githubsync":"","__v":46,"parentDoc":null}

Definition

https://sandbox.bluesnap.com/services/2/cp/user/<userId>


Documentation

The 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.

Examples

Request Example

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.