Re-send an invitation
const url = 'https://example.com/api/public/v1/invitations/resend';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"Id":"example","Email":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/public/v1/invitations/resend \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "Id": "example", "Email": "example" }'Sends the invitation again, addressed by corporate email or by id. An employee who has already granted access, and an archived one, are rejected — there is nothing to send in either case.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Addresses one employee record by either handle. Give exactly one: the corporate email the record was created with, or the id a previous call returned.
object
Examplegenerated
{ "Id": "example", "Email": "example"}Addresses one employee record by either handle. Give exactly one: the corporate email the record was created with, or the id a previous call returned.
object
Examplegenerated
{ "Id": "example", "Email": "example"}Addresses one employee record by either handle. Give exactly one: the corporate email the record was created with, or the id a previous call returned.
object
Examplegenerated
{ "Id": "example", "Email": "example"}Responses
Section titled “Responses”OK
What happened to one invitation. A record that already exists is reported here rather than rejected — bool InvitationResultDto.Created is false and EmployeeStatus InvitationResultDto.Status is the existing record’s current state.
object
The employee record’s id, whether it was created now or already existed.
True when this call created the record; false when it already existed.
Whether this call sent an invitation email. A record that already existed answers false — nothing was sent — and can be reached with resend.
Where this person’s card lives in the Portal. Opening it needs a signed-in Portal session — the link is an address, not access.
Example
{ "Status": "NotActivated"}Bad Request
The Integration API’s error shape — RFC 7807 application/problem+json. The Portal API answers
in its own { Error, Details } envelope because one client parses one shape; an external
integrator expects the standard instead.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Unauthorized
The Integration API’s error shape — RFC 7807 application/problem+json. The Portal API answers
in its own { Error, Details } envelope because one client parses one shape; an external
integrator expects the standard instead.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
The Integration API’s error shape — RFC 7807 application/problem+json. The Portal API answers
in its own { Error, Details } envelope because one client parses one shape; an external
integrator expects the standard instead.
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}