Skip to main content
POST
/
v1
/
transfers
Create a new transfer request
curl --request POST \
  --url http://0.0.0.0:3000/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to_email": "amigo@email.com",
  "resource_type": "config_entry",
  "resource_id": "42"
}
'
{
  "id": 1,
  "from_user_id": "user_abc123",
  "to_email": "amigo@email.com",
  "resource_type": "config_entry",
  "resource_id": "42",
  "status": "pending",
  "metadata": null,
  "created_at": "2026-03-17T10:00:00Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
to_email
string<email>
required

Email do destinatário

resource_type
enum<string>
required

Tipo do recurso

Available options:
config_entry,
dashboard,
automation,
script
resource_id
string
required

ID do recurso

metadata
object

Metadados opcionais

Response

Transfer created

id
integer
from_user_id
string
to_email
string
resource_type
string
resource_id
string
status
enum<string>
Available options:
pending,
accepted,
rejected,
cancelled
metadata
object
created_at
string<date-time>