Description
You have to call this method when you want to check the status of an unsubscription request made by user in DruID Identity (CIAM). This method is useful to know if a user has started the unsubscription process.
You will need a user logged with access token. You can not perform this operation with no logged user
Please, read first: https://dru-id.com/developers/apis/oauth-2/ to learn about Oauth2 protocol and the meaning of each token.
If you want to request an unsubscription, then you need to call the request unsubscribe endpoint.
Endpoint URL:
GET https://{{graph_host}}/activityid/v1/user/unsubscribe
Request parameters
| Parameter | Description | Type | Required |
|---|---|---|---|
| Authorization | “Bearer access_token” Literal text Bearer followed by access_token that is the user access token obtained from /oauth2/token endpoint | string | yes |
| Content-Type | The type of content that will be used for requests to be JSON | string | yes |
| Accept | The type of content that will be used for responses to be JSON | string | yes |
| From | Name of the entrypoint | string | yes |
| Accept-Language | Language for this request | Locale | no |
Query string parameters
| Parameter | Description | Type | Required | Default value |
|---|
Response examples
Response: Request success (Accepted)
Response codes
| Code | Type | Description |
|---|---|---|
| 400 | Error | Bad Request: The request could not be understood by the server due to malformed syntax |
| 401 | Error | Unauthorized: authentication is required and has failed or has not yet been provided (token is invalid, etc) |
| 404 | Success | Not Found: The user has NOT requested an unsubscription. |
| 428 | Error | Precondition required: User need to configure MFA or needs to send a MFA code. Check the MFA API |
| 500 | Error | Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request |
| 504 | Error | Gateway TimeoutService can not contact with oauth server to do some internal operations |
| 200 | Success | User has requested an unsubscription. The user account will be deleted if this process is not canceled |