Invitations

An invitation grants access to speak with one workspace agent. It is different from workspace membership.

curl -X POST "https://api.usevoicelink.co/v0/invitations" \
  -H "apikey: YOUR_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"agentId":"11111111-1111-4111-8111-111111111111","name":"Guest","expiresInDays":7}'

Creation returns data.invitation, including its shareUrl. If the agent is later deleted, the invitation remains readable and its shareUrl becomes null. Without email, this creates a link only. With an email address, the server starts asynchronous email delivery; creation success is not delivery confirmation. Each POST creates a new invitation, so retrying creation can send another email. You cannot send an invitation to your own email address.

Expiry choices are 3, 7, 14 and 30 days; creation defaults to 7. Unsupported values return 400.

Manage invitationsCopy Anchor Link

• List/read invitations and filter by agent or status: pending, used, revoked, or expired.
• PATCH an unexpired pending invitation's name, contextText, or message.
• POST /{id}/extend with expiresInDays to deliberately reset an unexpired pending invitation's expiry.
• POST /{id}/revoke to disable an unused link. A used invitation cannot be revoked.
• DELETE /{id} to remove the invitation without removing its associated call history.

Replace INVITATION_ID with the ID returned when you create the invitation.

curl -X POST "https://api.usevoicelink.co/v0/invitations/INVITATION_ID/revoke" \
  -H "Authorization: Bearer YOUR_API_KEY"

Revoked, used and expired invitations cannot start a new call. Editing an invitation does not extend it. Document uploads and resend are not supported by v0.