Cancel a flow

POST/admin/v1/flows/{flowId}:cancel

Cancel a flow.

path parameters

flowId
string
Required
The identifier of the 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
BASIC
The target organization for the flow.
id
string
The system-assigned identifier of the organization.
state
enum
The current state of the organization.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
phoneNumber
string
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
imageUrl
string
The photo/avatar URL of the organization.
currencyCode
string
The default ISO-4217 currency code for the organization (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the organization (e.g. en).
regionCode
string
The country/region code for the organization (e.g. US).
timeZone
string
The IANA time zone for the organization (e.g. America/New_York).
address
Address
The default address for the organization.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
signupTime
date-time
The sign-up time for the organization.
memberCount
int32
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
disabled
boolean
Whether the organization is disabled.
view
enum
The organization view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the organization.
updateTime
date-time
The last update time of the organization.
user
User
BASIC
The target user for the flow.
id
string
The system-assigned identifier of the user.
state
enum
The current state of the user.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
phoneNumber
string
The E164 phone number for the user (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the user's phone number has been verified.
imageUrl
string
The photo/avatar URL of the user.
currencyCode
string
The default ISO-4217 currency code for the user (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the user (e.g. en).
regionCode
string
The country/region code for the user (e.g. US).
timeZone
string
The IANA time zone for the user (e.g. America/New_York).
address
Address
The default address for the user.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
signupTime
date-time
The sign-up time for the user.
disabled
boolean
Whether the user is disabled.
view
enum
The user view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the user.
updateTime
date-time
The last update time of the user.
creator
User
BASIC
The user who created the flow.
This will not be set if the invitation was created by an admin.
id
string
The system-assigned identifier of the user.
state
enum
The current state of the user.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
phoneNumber
string
The E164 phone number for the user (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the user's phone number has been verified.
imageUrl
string
The photo/avatar URL of the user.
currencyCode
string
The default ISO-4217 currency code for the user (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the user (e.g. en).
regionCode
string
The country/region code for the user (e.g. US).
timeZone
string
The IANA time zone for the user (e.g. America/New_York).
address
Address
The default address for the user.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
signupTime
date-time
The sign-up time for the user.
disabled
boolean
Whether the user is disabled.
view
enum
The user view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the user.
updateTime
date-time
The last update time of the user.
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.
joinOrganization
JoinOrganizationFlow
The join organization flow type specific data.
displayName
string
The display name of the invitee.
email
string
The email address of the invitee.
role
Role
The role to be assigned to the invitee.
id
string
The system-assigned identifier of the role.
uniqueId
string
The client defined unique identifier of the role.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with role_ are reserved.
displayName
string
The human-readable display name of the role.
type
enum
The role type.
Possible values:
OWNERMEMBERGUEST
description
string
The description of the role.
The maximum length is 1000 characters.
seatPolicy
enum
The policy that defines how a member is assigned a seat.
Possible values:
DEFAULTMANUAL
permissionSets
string[]
The additional permissions allowed by the role.
default
boolean
Whether the role is the default for the tenant.
archived
boolean
The archived status of the role.
view
enum
The role view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the role.
updateTime
date-time
The last update time of the role.
signup
SignupFlow
The signup flow type specific data
email
string
The email address of the invitee.
displayName
string
The display name of the invitee.
createOrganization
boolean
Whether to create an organization as part of the signup flow.
view
enum
The flow view.
Possible values:
BASICFULL
createTime
date-time
The creation time of the flow.
updateTime
date-time
The last update time of the flow.

code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.

curl https://api.userhub.com/admin/v1/flows/flow_3on5rHNG5aMGao:cancel \
  -H "Authorization: Bearer $USERHUB_ADMIN_KEY" \
  -X POST

const res = await adminApi.flows.cancel(
  "flow_3on5rHNG5aMGao",
);

res, err := adminApi.Flows().Cancel(
    context.Background(),
    "flow_3on5rHNG5aMGao",
    nil,
)

$res = $adminApi->flows->cancel(
    flowId: 'flow_3on5rHNG5aMGao',
);

res = admin_api.flows.cancel(
    flow_id="flow_3on5rHNG5aMGao",
)

Response bodyJSON

{
  "id": "flow_3on5rHNG5aMGao",
  "state": "CANCELED",
  "type": "JOIN_ORGANIZATION",
  "organization": {
    "id": "org_28seyVGVL1got6",
    "state": "ACTIVE",
    "displayName": "Acme Inc",
    "email": "[email protected]",
    "emailVerified": true,
    "imageUrl": "https://example.com/acme.jpg",
    "accountConnections": [],
    "signupTime": "2025-05-15T13:00:00Z",
    "memberCount": 0,
    "view": "BASIC",
    "createTime": "2025-05-15T13:00:00Z",
    "updateTime": "2025-05-15T13:00:00Z"
  },
  "user": {
    "id": "usr_MKFxzgJaAH8JQ4",
    "state": "ACTIVE",
    "displayName": "Jane Doe",
    "email": "[email protected]",
    "emailVerified": true,
    "phoneNumber": "+12125550123",
    "phoneNumberVerified": false,
    "imageUrl": "https://example.com/jane.jpg",
    "currencyCode": "USD",
    "languageCode": "en",
    "regionCode": "US",
    "timeZone": "America/New_York",
    "address": {
      "lines": [
        "42 West St"
      ],
      "city": "Brooklyn",
      "state": "NY",
      "postalCode": "11222",
      "country": "US"
    },
    "accountConnections": [],
    "memberships": [],
    "signupTime": "2025-05-15T13:00:00Z",
    "view": "BASIC",
    "createTime": "2025-05-15T13:00:00Z",
    "updateTime": "2025-05-15T13:00:00Z"
  },
  "creator": {
    "id": "usr_EHTXpuz9rs8TCU",
    "state": "ACTIVE",
    "displayName": "John Doe",
    "email": "[email protected]",
    "emailVerified": false,
    "phoneNumber": "+12345678901",
    "phoneNumberVerified": false,
    "imageUrl": "https://example.com/john.jpg",
    "accountConnections": [],
    "memberships": [],
    "signupTime": "2025-05-15T13:00:00Z",
    "view": "BASIC",
    "createTime": "2025-05-15T13:00:00Z",
    "updateTime": "2025-05-15T13:00:00Z"
  },
  "expireTime": "2025-05-15T13:00:00Z",
  "joinOrganization": {
    "email": "[email protected]"
  },
  "view": "FULL",
  "createTime": "2025-05-15T13:00:00Z",
  "updateTime": "2025-05-15T13:00:00Z"
}

PreviousGet a flow

NextInvoices

Cancel a flow

.css-10iahqc{text-transform:capitalize;}path parameters

Returns

path parameters