User APIs

Archive User

OVERVIEW

Overview

Archive a user within Publisher

This API call is used to archive a user within the system. The user identifier is the user id of the user or their email address.

Since v4.6

HTTP Request

POST  /api/2/users/<ID>/archive

OR

POST  /api/2/users/<EMAIL>/archive

 

URL Parameters
Parameter Description
ID The ID of the user to archive
EMAIL The email address of the user to archive

 

HTTP Request Object

No data is passed in the HTTP Request

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token. "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
     

 

HTTP Response

Success

HTTP response 200 with User summary Object 

(Example below)

 

Error

See API Error messages 

Example HTTP Request & Response

POST http://example.com/context/api/2/users/3/archive

 

JSON Response

{

    "user": {

        "id": 3,

        "email": "user@domain.com",

        "link": "http://example.com/context/api/2/users/3"

    }

}

 

 

XML Response

<user>

    <id>3</id>

    <email>user@domain.com</email>

    <atom:link rel="self" href="http://example.com/context/api/2/users/3" />

</user>

 

Comments


0 Comments

Last Updated: Nov 08,2024