Skip to main content
POST
/
trigger-inbox
/
api
/
v1
/
inboxes
/
{inbox_id}
/
messages
/
lease
curl --request POST \
  --url https://api.zapier.com/trigger-inbox/api/v1/inboxes/{inbox_id}/messages/lease \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lease_limit": 1
}
'
{
  "lease_id": null,
  "leased_until": null,
  "results": [],
  "inbox_attributes": {
    "status": "active",
    "paused_reason": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.zapier.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Path Parameters

​
inbox_id
string<uuid>
required

Body

application/json

Request to lease message from an inbox.

​
lease_seconds
integer
default:300

The number of seconds to lease the message for.

Required range: 1 <= x <= 3600
​
lease_limit
integer
default:10

The number of messages to lease.

Required range: 1 <= x <= 100

Response

Response for a message lease request to an inbox.

Response for a message lease request to an inbox.

​
lease_id
string<uuid> | null
required

The unique identifier for the lease.

​
leased_until
string<date-time> | null
required

The timestamp until which the messages are leased in ISO 8601 format.

​
results
object[]
required

The list of messages leased.

​
inbox_attributes
object
required

Current inbox state surfaced alongside the lease.