OXoxlo
Admin

Create Invite Code

Create a new invite code for a plan.

Admins can either:

  • Provide an explicit code, or
  • Provide a company_prefix to auto-generate a code.
post/admin/plans/{plan_id}/codes

Request

  • Base URL
    https://api.oxlo.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.oxlo.ai/admin/plans/{plan_id}/codes
  • Auth
    HTTP bearer

Path parameters

plan_idstring required

Request body

plan_idstring nullable
company_prefixstring nullable
codestring nullable
max_usesinteger nullable
expires_atstring date-time nullable

Response

Successful Response

codestring required
plan_idstring required
plan_namestring nullable required
max_usesinteger nullable required
uses_countinteger required
is_activeboolean required
is_expiredboolean required
can_useboolean required
created_atstring date-time required
expires_atstring date-time nullable
created_bystring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.