SendInvitationBodyDto

connectionIdstringrequired

Connection to send the invitation on

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

didstring

DID of the service the peer is invited to connect to (referral). When absent, the invitation opens a sub-connection to this agent.

Example: did:webvh:QmbfsYcjFS2bnouwXBSoZZ65jREEgZGSPdcatcwY7i1Gq2:verifier.example.com

labelstring

Text the peer shows for the invitation. On a v2 connection it travels as the description of the share-media message and as the metadata.title of its item. Sub-connection default: the name of the ECS-Service credential of the agent, omitted when it holds none.

Example: My Service

imageUrlstring

URL of an image the peer shows for the invitation. On a v2 connection it travels as the metadata.icon of the item of the share-media message.

Example: https://example.com/logo.png

goalstring

The goal of the invitation

Example: Open a support chat

goalCodestring

The goal_code of the invitation

Example: support-chat

SendInvitationBodyDto

{
  "connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "did": "did:webvh:QmbfsYcjFS2bnouwXBSoZZ65jREEgZGSPdcatcwY7i1Gq2:verifier.example.com",
  "label": "My Service",
  "imageUrl": "https://example.com/logo.png",
  "goal": "Open a support chat",
  "goalCode": "support-chat"
}