CRM

Initiate the forgot password flow.

Sends an email to the user with a link to a page where they can reset their password. The reset password token in the link is valid for 30 minutes.

post/api/v1/crm/people/forgotPassword

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/crm/people/forgotPassword
Auth: one of:
- HTTP bearer
- API key in header Authorization

Request body

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

SchemaLessDataobject nullable

Emailstring email nullable

FirstNamestring nullable

LastNamestring nullable

PasswordLastUpdatedstring date-time nullable

PasswordMustChangeboolean

PhoneMobilestring nullable

PhoneWorkstring nullable

ProfileImageS3Urlstring nullable

Titlestring nullable

Timezonestring nullable

Languagestring nullable

IPAddressstring nullable

Refererstring nullable

UserAgentstring nullable

LastLoginDateTimestring date-time nullable

OAuthGoogleProfileIdstring nullable

AccountUidsstring nullable

FullNamestring nullable

HasLoggedInboolean

OAuthIntegrationStatus0 | 1

0 - None, 1 - Gmail

OptInToEmailListboolean

Passwordstring nullable

RecaptchaTokenstring nullable

UserAgentPlatformBrowserstring nullable

HasUnsubscribedboolean

IsConnectedToDiscordboolean

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "SchemaLessData": {},
  "Email": "string",
  "FirstName": "string",
  "LastName": "string",
  "MailingAddress": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "AddressLine1": "string",
    "AddressLine2": "string",
    "AddressLine3": "string",
    "City": "string",
    "State": "string",
    "PostalCode": "string",
    "Country": "string",
    "GeoLocation": "string"
  },
  "PasswordLastUpdated": "string",
  "PasswordMustChange": false,
  "PhoneMobile": "string",
  "PhoneWork": "string",
  "ProfileImageS3Url": "string",
  "Title": "string",
  "Timezone": "string",
  "Language": "string",
  "IPAddress": "string",
  "Referer": "string",
  "UserAgent": "string",
  "LastLoginDateTime": "string",
  "OAuthGoogleProfileId": "string",
  "PersonAccount": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Person": {},
      "Account": {},
      "IsPrimary": false,
      "ReceiveInvoices": false,
      "Role": 1
    }
  ],
  "DealPeople": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Person": {},
      "Deal": {}
    }
  ],
  "LeadFormSubmissions": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Person": {},
      "LeadForm": {},
      "RefererURL": "string",
      "HasPendingFields": false,
      "Fields": [],
      "RecaptchaToken": "string",
      "RecaptchaSiteKey": "string"
    }
  ],
  "Account": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "StripeId": "string",
    "IsLivemode": false,
    "Name": "string",
    "ClientIdentifier": "string",
    "Currency": "string",
    "InvoiceNotes": "string",
    "IsDemo": false,
    "BillingAddress": {},
    "MailingAddress": {},
    "AccountStage": 2,
    "PaymentInformation": {},
    "PersonAccount": [],
    "StripeDefaultPaymentMethodId": "string",
    "StripeInvoices": [],
    "StripePaymentMethods": [],
    "StripeSubscriptions": [],
    "Subscriptions": [],
    "Deals": [],
    "LastLoginDateTime": "string",
    "AccountSpecificPageUrl1": "string",
    "AccountSpecificPageUrl2": "string",
    "AccountSpecificPageUrl3": "string",
    "AccountSpecificPageUrl4": "string",
    "AccountSpecificPageUrl5": "string",
    "AccountSpecificPageUrl6": "string",
    "AccountSpecificPageUrl7": "string",
    "AccountSpecificPageUrl8": "string",
    "AccountSpecificPageUrl9": "string",
    "AccountSpecificPageUrl10": "string",
    "RewardFulReferralId": "string",
    "ToltReferralId": "string",
    "TaxIds": [],
    "TaxStatus": "string",
    "AccountStageLabel": "string",
    "CurrentStripeProducts": "string",
    "CurrentStripeProductInstances": [],
    "CurrentSubscription": {},
    "DomainName": "string",
    "TenantBillingSystem": 1,
    "HasLoggedIn": false,
    "LatestSubscription": {},
    "LifetimeRevenue": 0,
    "NextStripeInvoiceDate": "string",
    "Nonce": "string",
    "PrimaryContact": {},
    "PrimarySubscription": {},
    "PrimaryStripeSubscription": {},
    "RecaptchaToken": "string",
    "StripeCheckoutMetadata": {},
    "StripeNextInvoiceSequence": 0,
    "StripePrice": [],
    "StripePriceIds": "string",
    "StripePromotionCode": "string",
    "TaxId": "string",
    "TaxIdIsInvalid": false,
    "TaxIdType": "string",
    "WebflowSlug": "string"
  },
  "AccountUids": "string",
  "EmailListPerson": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "EmailList": {},
      "Person": {},
      "EmailListSubscriberStatus": 1,
      "SubscribedDate": "string",
      "ConfirmedDate": "string",
      "ConfirmationNotes": "string",
      "UnsubscribedDate": "string",
      "CleanedDate": "string",
      "WelcomeEmailDeliverDateTime": "string",
      "WelcomeEmailOpenDateTime": "string",
      "UnsubscribeReason": "string",
      "UnsubscribeReasonOther": "string",
      "RecaptchaToken": "string",
      "RecaptchaSiteKey": "string",
      "SendWelcomeEmail": false,
      "Source": "string"
    }
  ],
  "FullName": "string",
  "HasLoggedIn": false,
  "OAuthIntegrationStatus": 0,
  "OptInToEmailList": false,
  "Password": "string",
  "RecaptchaToken": "string",
  "UserAgentPlatformBrowser": "string",
  "HasUnsubscribed": false,
  "DiscordUser": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "DiscordUserId": "string",
    "DiscordEmail": "string",
    "DiscordUsername": "string",
    "DiscordOAuthRefreshToken": "string"
  },
  "IsConnectedToDiscord": false
}

Changes

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