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

tostring

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.

descriptionstring

Message shown to whoever is asked to approve or claim it.

maxClaimsobject

Open invites only: how many people may claim this one link. The service owns the ceiling and refuses anything past it.

Response

Created

oktrue required
statusstring required
agreementIdstring nullable required
shareUrlstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.