POST/admin/v1/flows:createJoinOrganization

Send a join organization invitation

Create a join organization flow. This invites a person to join an organization.

body parameters

  • organizationId

    string

    Required

    The identifier of the organization.

  • userId

    string

    The identifier of the user.

    This is required if email is not specified.

  • email

    string

    The email address of the person to invite.

    This is required if user is not specified or the user does not have an email address.

  • displayName

    string

    The display name of the person to invite.

  • creatorUserId

    string

    The identifier of the user sending the invite.

  • expireTime

    date-time

    The time the flow will expire.

    This field is not allowed if ttl is specified.

  • ttl

    string

    The amount of time a flow will be available (e.g. 86400s).

    This must be a string with the number of seconds followed by a trailing s.

    This field is not allowed if expireTime is specified.

Returns

  • id

    string

    The system-assigned identifier of the flow.

  • state

    enum

    The current state of the flow.

    Possible values:
    START_PENDINGSTARTEDCOMPLETEDCANCELEDEXPIRED
  • stateReason

    string

    The code that best describes the reason for the state.

  • type

    enum

    The flow type.

    Possible values:
    JOIN_ORGANIZATIONSIGNUP
  • organization

    Organization

    The target organization for the flow.

  • user

    User

    The target user for the flow.

  • creator

    User

    The user who created the flow.

    This will not be set if the invitation was created by an admin.

  • startTime

    date-time

    The start time of the flow.

  • expireTime

    date-time

    The time the flow will expire.

  • ttl

    string

    The expire duration of the flow.

  • secret

    string

    The flow secret.

    This is only populated on create.

  • createTime

    date-time

    The creation time of the flow.

  • updateTime

    date-time

    The last update time of the flow.

  • joinOrganization

    JoinOrganizationFlow

    The join organization flow type specific data.

  • signup

    SignupFlow

    The signup flow type specific data

curl https://api.userhub.com/admin/v1/flows:createJoinOrganization \
  -H "Authorization: Bearer $ADMIN_API_KEY" \
  --json '{
    "organizationId": "org_28seyVGVL1got6",
    "email": "[email protected]"
  }'
Response bodyJSON
{
  "id": "flow_3on5rHNG5aMGao",
  "state": "START_PENDING",
  "type": "JOIN_ORGANIZATION",
  "organization": {
    "id": "org_28seyVGVL1got6",
    "state": "ACTIVE",
    "displayName": "Acme Inc",
    "email": "[email protected]",
    "emailVerified": true,
    "imageUrl": "https://example.com/acme.jpg",
    "address": null,
    "accountConnections": [],
    "subscription": null,
    "signupTime": "2024-06-15T13:00:00Z",
    "memberCount": 0,
    "createTime": "2024-06-15T13:00:00Z",
    "updateTime": "2024-06-15T13:00:00Z"
  },
  "user": null,
  "creator": null,
  "startTime": null,
  "expireTime": "2024-07-15T13:00:00Z",
  "secret": "2gyargv7uuqwo72LciAa9HRdnmMX2Mr9geQRmm",
  "createTime": "2024-06-15T13:00:00Z",
  "updateTime": "2024-06-15T13:00:00Z",
  "joinOrganization": {
    "email": "[email protected]",
    "role": null
  }
}
PreviousList flows
NextSend a signup invitation

Turn users intorevenue
$

Subscribe to monthly product updates

© 2024 UserHub

Integrations

    UserHub & Auth0UserHub & Stripe BillingUserHub & Google CloudUserHub & FirebaseUserHub & custom auth