Skip to main content
POST
/
actions
/
archive
Archive a message
curl --request POST \
  --url https://api.hyperspell.com/actions/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message_id": "<string>",
  "provider": "gmail_actions",
  "connection": "<string>"
}
'
{
  "success": true,
  "error": "<string>",
  "provider_response": {}
}

Authorizations

​
Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Body

application/json

Archive a Gmail message.

​
message_id
string
required

Gmail message ID to archive

​
provider
enum<string>
default:gmail_actions

Integration provider

Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
box,
dropbox,
google_drive,
github,
vault,
web_crawler,
trace,
microsoft_teams,
gmail_actions
​
connection
string | null

Connection ID. If omitted, auto-resolved from provider + user.

Response

Successful Response

Result from executing an integration action.

​
success
boolean
required
​
error
string | null
​
provider_response
Provider Response · object