Disconnect an email account

POST

/emails/accounts/{email}/disconnect

const url = 'https://api.clearance.rest/emails/accounts/example/disconnect';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.clearance.rest/emails/accounts/example/disconnect \
  --header 'X-API-Key: <X-API-Key>'

Stops notifications and removes the account from the project. For a Cloudflare address nothing changes at Cloudflare; a new email to it registers it again as a new address.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

email

required

string

>= 3 characters

Email address (URL-encoded).

Responses

200

Default Response

application/json

object

success

required

boolean

Example

{
  "success": true
}

401

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

403

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

404

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}