Team and licences
Invite a person to the team
Invites a person by email with a role and licences. For a SautiDesk invitation, the person becomes an active member and is billed from the moment they accept.
Requires: desk.admin scope, workspace owner or admin.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Request Body
application/json
Response
Created
Example
{ "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "email": "amina@example.com", "name": "Amina Wanjiru", "role": "agent", "status": "open", "product": "desk", "invite_url": "https://example.com/file", "licences": [ "converse" ], "expires_at": "2026-10-14T08:30:00Z", "created_at": "2026-10-14T08:30:00Z", "accepted_at": "2026-10-14T08:30:00Z", "seat_billable": false, "seat_billable_from": "2026-11-01", "seat_note": "Billed from the next period", "invited_by": "Wanjiku Mwangi", "invited_via": "example"}FieldTypeDescription
idrequiredstringemailrequiredstringAn email address.namestringA name for it.rolerequiredstringThe role: admin, agent or viewer.statusrequiredstringThe status to set.productrequiredstringdesk to invite the person to SautiDesk, or kit to invite them to SautiKit only.invite_urlstringlicencesrequiredstring[]The Desk licences to give: converse (tickets and conversations), contacts (the address book) and supervisor (reports and listening in).expires_atrequiredstringcreated_atrequiredstringaccepted_atstringseat_billablerequiredbooleanseat_billable_fromstringseat_notestringinvited_bystringinvited_viastringcurl -X POST "https://api.sautidesk.com/v1/invitations" \ -H "Content-Type: application/json" \ -d '{ "email": "amina@example.com", "role": "agent", "name": "Amina Wanjiru", "licences": [ "converse" ], "product": "desk" }'