Restore trashed messages in bulk

POST

/v1/messages/batch/untrash

curl --request POST \
  --url https://api.inboxcnx.com/v1/messages/batch/untrash \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ids": [ "c4a7e2b9-1d3f-4e6a-8b0c-5f2d9e7a1b34", "f0e1d2c3-b4a5-4968-8776-5a4b3c2d1e0f" ] }'

Restore trashed messages in bulk at the provider: up to 100 messages of one grant per call, each as POST /v1/messages/{id}/untrash handles one. Moves a message out of the trash at the provider, to undo a delete. The message lands in inbox, whatever folder it came from.

Requires the delete:messages scope.

Authorizations

• apiKey
• grantToken

Request Body

Media typeapplication/json

object

ids

required

Array<string>

>= 1 items <= 100 items

Example

{
  "ids": [
    "c4a7e2b9-1d3f-4e6a-8b0c-5f2d9e7a1b34",
    "f0e1d2c3-b4a5-4968-8776-5a4b3c2d1e0f"
  ]
}

Responses

200

How many moved

Media typeapplication/json

object

updated

required

integer

failed

required

Array<object>

object

id

required

string

code

required

string

Example ^generated

{
  "updated": 1,
  "failed": [
    {
      "id": "example",
      "code": "example"
    }
  ]
}

400

Invalid body. mixed_grants: the ids belong to more than one grant

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 delete:messages scope

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

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

404

messages_not_found: ids lists the unknown ones. provider_message_not_found: the provider no longer has one of them

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"
  }
}