POST {clientId}/Profile/{profileId}/Deactivate

This method will deactivate the profile that matches the ProfileId specified in the URI. If successful, it updates the IsActive flag to false. Once you deactivate a profile, you will only be able to retrieve the profile by the Profile Id explicitly. It will no longer be accessible via any of the Search calls (GET Profile or GET Preferences calls), if you search on something other than a Profile Id. You must reactivate the profile in order to access it by something other than Profile Id. The preferences will be deactivated if the PreservePreferences flag on your profile is set to false. If it’s set to true, the preferences will remain intact

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	This is your organization’s MyPreferences account Id.	string	Required
profileId	Id associated with the profile that you want to deactivate.	integer	Required

Body Parameters

Name	Description	Type	Additional information
Reason	Optional reason that the profile is being deactivated	string	Max length: 256

Request Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "Reason": "sample string 1"
}

application/xml, text/xml

Sample:

<ReasonCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <Reason>sample string 1</Reason>
</ReasonCode>

Response Information

Response Codes

HTTP Status Code	Text	Description
200	OK	The request was successfully processed.
400	Bad Request	The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401	Unauthorized	Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403	Forbidden	The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Resource Description

None.

Response Formats

application/json, text/json, application/json-patch+json, application/xml, text/xml

Sample:

Sample not available.