CRM

Add a person to an existing account. Set sendWelcomeEmail=true to send a welcome email to the person added.

post/api/v1/crm/accounts/{accountUid}/memberships

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/crm/accounts/{accountUid}/memberships
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

accountUidstring nullable required

The account's unique identifier

Request body

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
IsPrimaryboolean
ReceiveInvoicesboolean
Role1 | 2 | 3

1 - Admin, 2 - Member, 3 - Operator

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "Person": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "MailingAddress": {},
    "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": [],
    "DealPeople": [],
    "LeadFormSubmissions": [],
    "Account": {},
    "AccountUids": "string",
    "EmailListPerson": [],
    "FullName": "string",
    "HasLoggedIn": false,
    "OAuthIntegrationStatus": 0,
    "OptInToEmailList": false,
    "Password": "string",
    "RecaptchaToken": "string",
    "UserAgentPlatformBrowser": "string",
    "HasUnsubscribed": false,
    "DiscordUser": {},
    "IsConnectedToDiscord": false
  },
  "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"
  },
  "IsPrimary": false,
  "ReceiveInvoices": false,
  "Role": 1
}

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
IsPrimaryboolean
ReceiveInvoicesboolean
Role1 | 2 | 3

1 - Admin, 2 - Member, 3 - Operator

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "Person": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "MailingAddress": {},
    "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": [],
    "DealPeople": [],
    "LeadFormSubmissions": [],
    "Account": {},
    "AccountUids": "string",
    "EmailListPerson": [],
    "FullName": "string",
    "HasLoggedIn": false,
    "OAuthIntegrationStatus": 0,
    "OptInToEmailList": false,
    "Password": "string",
    "RecaptchaToken": "string",
    "UserAgentPlatformBrowser": "string",
    "HasUnsubscribed": false,
    "DiscordUser": {},
    "IsConnectedToDiscord": false
  },
  "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"
  },
  "IsPrimary": false,
  "ReceiveInvoices": false,
  "Role": 1
}

Changes

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