Send an invitation
osa_id and role are required. The person sees the invitation in the OSA app and accepts or declines it. An invitation that isn’t answered expires after 7 days. The invitation shows the person your organisation’s name and invited_as. Nothing about your claims reaches them until they accept.
Roles
role is required. It is OSA’s role kind, not your own title for the role. Which roles you can invite depends on your partner type and your setup with OSA. Today: adjuster.
Any other value, including a different spelling such as "Adjuster", is refused with 422 validation_failed.
Your notes
Four optional fields record who an invitation is for and why. To send no note, leave the field out:null and an empty string are refused with 422 validation_failed.
- They are your own notes. Nothing is checked against the person’s account, and no invitation is refused because of them. Whoever owns the OSAID can accept.
- The person sees
invited_ason the invitation in the app. The other three are for you only. - They are returned whenever members are listed. Each member in
GET /v1/memberscarries all four, and so do the responses to sending and withdrawing an invitation. A note you didn’t send isnull. - Inviting again replaces them. A new invitation to the same person replaces all four with whatever it sends. A note the new invitation leaves out becomes
null.
What the person needs before accepting
The person must have a first name, a last name and an email on their OSA profile before they can accept an invitation. If one is missing, the invitation can’t be accepted until they complete their profile in the app. If someone tells you they can’t accept, ask them to check their profile in the OSA app.Follow the invitation
roles is a list of role kinds, because a person can hold more than one role. Everyone invited through the API has adjuster. A person whose roles in your organisation have no kind (for example, roles set up for your organisation before role kinds existed) is listed with an empty list, [].
name and email are null until the person accepts. After that they are the account’s own name and email. invited_as stays what you wrote, so it can differ from name: compare the two if you need to confirm that the person you meant to invite is the one who accepted.
A member can leave your organisation in the app. One who has left no longer appears in the list, under any status. Claims an adjuster had already accepted stay with them; new claims sent to them are refused with 422 adjuster_not_a_member. Invite them again to bring them back.
Statuses and role kinds are open enums: handle values you don’t recognise without failing.
Inviting again and withdrawing
- You can invite someone again after they declined, after the invitation expired, or after you withdrew it.
- Inviting a current member returns
409 already_member. Inviting someone whose invitation is still pending returns409 invitation_pending. DELETE /v1/members/invitations/{osa_id}withdraws a pending invitation.