Sign in
Access

Changed on

Invite someone by email to a business organization of the caller's account (access.manage), with an organization role. The role may be workspace:auditor (an auditor, period close D15) while PERIOD_CLOSE_ENABLED is on: Enterprise only while plans are enforced (403 PLAN_FEATURE), at most 5 auditors per organization counting live pending auditor invitations (409 AUDITOR_LIMIT {limit, used}), and an auditor takes no plan seat; any other role counts against the plan's member limit (409 PLAN_LIMIT). The invitation is delivered through Clerk.

post/access/member-invitations

Request

  • Base URL: https://api.greentally.ai/v1
  • URL: https://api.greentally.ai/v1/access/member-invitations
  • Auth: HTTP bearer

Request body

emailstring required
organizationIdstring required

The business organization's external id

rolestring required

Preset role values or custom role values in the form custom:{externalId}. workspace:auditor (an auditor: read-only, closed periods only, through auditor workspace grants) is assignable while PERIOD_CLOSE_ENABLED is on; Enterprise (403 PLAN_FEATURE while PLANS_ENFORCED is on); at most 5 per organization, counting live pending auditor invitations (409 AUDITOR_LIMIT {limit, used}); auditors take no plan seat.

Response

The pending invitation

Changes