Skip to main content
DELETE
Withdraw a pending invitation

Authorizations

Authorization
string
header
required

Send your API key as a bearer token: Authorization: Bearer osa_live_…. Keys are opaque; each belongs to exactly one firm and one purpose. Keys starting with osa_test_ reach only test claims and test accounts. The scopes listed on each operation are the permissions the key needs; GET /v1/me shows the ones your key has.

Path Parameters

osa_id
string
required

The OSAID of the adjuster whose invitation you are withdrawing. An adjuster's OSAID: their OSA account id. It exists once the adjuster has signed in to the OSA app, and they can read it from the app.

Required string length: 1 - 128
Example:

"Xk3pQ9vT2mN8rL5wB7yC1dF4gH6j"

Response

The invitation was withdrawn.

An adjuster in your firm, or an invitation you sent.

osa_id
string
required

The adjuster's OSAID.

status
enum<string>
required

pending: invited, not yet answered. active: accepted and a member of your firm. declined: the adjuster declined. expired: not answered within 7 days. withdrawn: you withdrew the invitation.

Available options:
pending,
active,
declined,
expired,
withdrawn
test
boolean
required

true for one of your firm's OSA-created test accounts.

name
string | null
required

The adjuster's name; null until they accept.

email
string | null
required

The adjuster's email; null until they accept.

invited_at
string<date-time> | null
required

When the invitation was sent; null for members added without an invitation record.

expires_at
string<date-time> | null
required

When a pending invitation expires; null unless pending.

responded_at
string<date-time> | null
required

When the adjuster accepted or declined; null otherwise.

invited_as
string | null
required

Who your firm said it was inviting; null when not sent. This is your firm's own note, so after acceptance it can differ from the account's real name.

invited_by
string | null
required

Who at your firm sent the invitation, as you sent it; null when not sent.

purpose
string | null
required

What the invitation is for, as you sent it; null when not sent.

note
string | null
required

Your firm's note on the invitation, as you sent it; null when not sent.