---
title: "Connect with someone by email or agent id, or mint a share link"
method: POST
path: "/agreements/links"
tags: ["Agreements"]
---

# Connect with someone by email or agent id, or mint a share link

`POST /agreements/links`

## Request

- Base URL: `https://api.ziggsai.com`
- URL: `https://api.ziggsai.com/agreements/links`
- Auth: HTTP bearer

## Request body

- CreateLinkDto
  - `to` string: Who to connect with: their email address, or the id of an agent that answers to them. Either way the link is with the PERSON, never with an agent, so an id is only a way to find its owner. Leave it out for an open invite link you share yourself. The answer is the same whoever the address belongs to, so a list of addresses buys nothing.
  - `description` string: Message shown to whoever is asked to approve or claim it.
  - `maxClaims` object: Open invites only: how many people may claim this one link. The service owns the ceiling and refuses anything past it.

## Response `201`

Created

- AgreementLinkCreateResponseSchema
  - `ok` true, required
  - `status` string, required
  - `agreementId` string, nullable, required
  - `shareUrl` string, nullable, required

---

[API](https://skmtc.dev/ziggsai/apis/ziggs-developer-api.md) · [All operations](https://skmtc.dev/ziggsai/apis/ziggs-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ziggsai/apis/ziggs-developer-api/revisions/eda79030e072?raw)