POST

/user/v1/flows:createSignup

Send a signup invitation

Creates a signup flow. This invites a person to join the app.

body parameters

  • email

    string

    Required

    The email address of the person to invite.

  • displayName

    string

    The display name of the person to invite.

  • createOrganization

    boolean

    Whether to create an organization as part of the signup flow.

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.

  • expireTime

    date-time

    The time the flow will expire.

  • createTime

    date-time

    The creation 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/user/v1/flows:createSignup \
  -H "UserHub-Api-Key: $USER_API_KEY" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" \
  --json '{
    "email": "[email protected]"
  }'
Response bodyJSON
{
  "id": "flow_2VSCZXUfZVeRY3",
  "state": "START_PENDING",
  "type": "SIGNUP",
  "organization": null,
  "user": null,
  "creator": {
    "id": "usr_EHTXpuz9rs8TCU",
    "displayName": "Jane Doe",
    "email": "[email protected]",
    "emailVerified": true,
    "imageUrl": "https://example.com/jane.jpg"
  },
  "expireTime": "2024-07-15T13:00:00Z",
  "createTime": "2024-06-15T13:00:00Z",
  "signup": {
    "email": "[email protected]"
  }
}
PreviousSend a join organization invitation
NextGet a flow

Turn users intorevenue
$

Subscribe to monthly product updates

© 2024 UserHub

Integrations

    UserHub & Auth0UserHub & Stripe BillingUserHub & Google CloudUserHub & FirebaseUserHub & Custom Auth