Report a message as spam

POST

/v1/messages/{id}/report-spam

curl --request POST \
  --url https://api.inboxcnx.com/v1/messages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/report-spam \
  --header 'Authorization: Bearer <token>'

Reports a message as spam to the provider and moves it to the spam folder, which also trains the provider’s filter. The provider empties its spam folder on its own schedule (Gmail after 30 days). The stored copy stays.

Requires the report:spam scope.

Authorizations

• apiKey
• grantToken

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

The message’s new state

Media typeapplication/json

object

id

required

string

keywords

required

object

key

additional properties

boolean

labels

required

object

system

required

Array<string>

Allowed values: inbox archive drafts sent trash junk all flagged important

custom

required

Array<string>

stateAt

required

string | null

Example

{
  "id": "c4a7e2b9-1d3f-4e6a-8b0c-5f2d9e7a1b34",
  "keywords": {
    "$seen": true
  },
  "labels": {
    "system": [
      "junk"
    ],
    "custom": []
  },
  "stateAt": "2026-10-23T08:00:00.000Z"
}

400

The id is not a UUID

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

The credential lacks the report:spam scope

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

message_not_found: no such message. provider_message_not_found: the provider no longer has it

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

message_deleted: the mail is deleted at the provider. connection_unreadable: the mailbox cannot be reached and may need a reconnect. connection_scope_missing: the end user did not grant the scope the action needs, named in scope. A reconnect grants it

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

provider_unavailable: the provider is down or rate-limits the mailbox. Retry after Retry-After seconds

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}