Make an invite link

POST

/api/households/current/invites

curl --request POST \
  --url http://localhost:3000/api/households/current/invites \
  --header 'Content-Type: application/json' \
  --cookie merran.session_token=<merran.session_token> \
  --data '{ "role": "member" }'

• Your Merran

Household admins only. The link works once, for 7 days. Send it to the person; it’s shown only now.

Authorizations

• session

Request Body^required

Media typeapplication/json

object

role

string

default: member

Allowed values: admin member

Example

{
  "role": "member"
}

Responses

201

Made.

Media typeapplication/json

object

id

required

string

role

required

string

Allowed values: admin member

expiresAt

required

string format: date-time

createdAt

required

string format: date-time

link

required

string format: uri

Example

{
  "id": "0199e8b0-5a10-7a01-8b00-00000000000a",
  "role": "member",
  "expiresAt": "2026-10-22T18:30:00.000Z",
  "createdAt": "2026-10-15T18:30:00.000Z",
  "link": "https://merran.example.com/join/sample-invite-token"
}

401

Not signed in.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

403

Not allowed.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}