Create a participant and optional household; queue new household access invitations.
Create a participant and optional household; queue new household access invitations. Requires participants.write. All writes require Idempotency-Key; x-scope-rules declares additional grants by input condition.
/commands/create_participantAuthorizationBearer token (soljio_sk_<secret>) · headerrequiredOrganization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.
Idempotency-KeystringrequiredPersist with the job and reuse for retries. Scoped to organization, token, command and API version. Different input with the same key returns 409. Supported automatic retry window: 24 hours.
application/jsonconsent_statusstringShow propertiesHide properties
stringstringstringstringdate_of_birthstringdisplay_namestringexternal_referencestringfamily_namestringgiven_namestringhousehold_idstringOpaque Soljio resource ID.
household_memberobjectShow propertiesHide properties
display_namestringemailstringphonestringrelationshipstringrolestringShow propertiesHide properties
stringstringstringstringhousehold_namestringparticipant_subjectstringShow propertiesHide properties
stringstringprovider_visibilitystringShow propertiesHide properties
stringstringstringstatusstringShow propertiesHide properties
stringstringstringResource created; replay preserves the original result and Location.
dataobjectrequiredShow propertiesHide properties
household_claim_invitation_idstringOpaque Soljio resource ID.
household_idstringOpaque Soljio resource ID.
household_member_idstringOpaque Soljio resource ID.
okbooleanrequiredparticipant_idstringrequiredOpaque Soljio resource ID.
participant_organization_link_idstringrequiredOpaque Soljio resource ID.
job_idstringOpaque Soljio resource ID.
idempotent_replaybooleanrequiredrequest_idstring<uuid>requiredinvalid_request
errorobjectrequiredShow propertiesHide properties
codestringrequiredinvalid_requestmessagestringrequiredrequest_idstring<uuid>requiredunauthorized
errorobjectrequiredShow propertiesHide properties
codestringrequiredunauthorizedmessagestringrequiredrequest_idstring<uuid>requiredforbidden
errorobjectrequiredShow propertiesHide properties
codestringrequiredforbiddenmessagestringrequiredrequest_idstring<uuid>requirednot_found
errorobjectrequiredShow propertiesHide properties
codestringrequirednot_foundmessagestringrequiredrequest_idstring<uuid>requiredmethod_not_allowed
errorobjectrequiredShow propertiesHide properties
codestringrequiredmethod_not_allowedmessagestringrequiredrequest_idstring<uuid>requiredconflict, idempotency_conflict
errorobjectrequiredShow propertiesHide properties
codestringrequiredconflictidempotency_conflictmessagestringrequiredrequest_idstring<uuid>requiredpayload_too_large
errorobjectrequiredShow propertiesHide properties
codestringrequiredpayload_too_largemessagestringrequiredrequest_idstring<uuid>requiredunsupported_media_type
errorobjectrequiredShow propertiesHide properties
codestringrequiredunsupported_media_typemessagestringrequiredrequest_idstring<uuid>requiredrate_limited
errorobjectrequiredShow propertiesHide properties
codestringrequiredrate_limitedmessagestringrequiredrequest_idstring<uuid>requiredinternal_error
errorobjectrequiredShow propertiesHide properties
codestringrequiredinternal_errormessagestringrequiredrequest_idstring<uuid>required