POST api/AuthorWelcomeEmails/SendFirmAdminWelcomeEmail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Email	string	Required
Type	JDSupraAccountType	Required
SendFirmAdminWelcomeEmail	boolean	Required
AdminName	string	None.
TargetFirmInfo	Collection of FirmAdminInfoView	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Type": 0,
  "SendFirmAdminWelcomeEmail": true,
  "AdminName": "sample string 3",
  "TargetFirmInfo": [
    {
      "UserId": "sample string 1",
      "user_id": 2,
      "profile_id": 3,
      "dateAdded": "2026-02-02T11:56:51.4146304+00:00",
      "firmName": "sample string 4",
      "emailOptin": "sample string 5",
      "profileType": 1,
      "linkedInAccessToken": "sample string 6",
      "linkedInTokenExpDate": "sample string 7",
      "linkedInProfileURL": "sample string 8",
      "linkedInInfo": "sample string 9",
      "profileIsLive": true,
      "imageName": "sample string 10",
      "imageType": "sample string 11",
      "currentPremiumLevel": 1,
      "URLString": "sample string 12",
      "status": true,
      "claimDateAdded": "2026-02-02T11:56:51.4146304+00:00",
      "claimDateUpdated": "2026-02-02T11:56:51.4146304+00:00",
      "parentID": 1,
      "FirstName": "sample string 13",
      "LastName": "sample string 14",
      "Title": "sample string 15",
      "Email": "sample string 16",
      "IsEnabled": true,
      "last_action": "sample string 18"
    },
    {
      "UserId": "sample string 1",
      "user_id": 2,
      "profile_id": 3,
      "dateAdded": "2026-02-02T11:56:51.4146304+00:00",
      "firmName": "sample string 4",
      "emailOptin": "sample string 5",
      "profileType": 1,
      "linkedInAccessToken": "sample string 6",
      "linkedInTokenExpDate": "sample string 7",
      "linkedInProfileURL": "sample string 8",
      "linkedInInfo": "sample string 9",
      "profileIsLive": true,
      "imageName": "sample string 10",
      "imageType": "sample string 11",
      "currentPremiumLevel": 1,
      "URLString": "sample string 12",
      "status": true,
      "claimDateAdded": "2026-02-02T11:56:51.4146304+00:00",
      "claimDateUpdated": "2026-02-02T11:56:51.4146304+00:00",
      "parentID": 1,
      "FirstName": "sample string 13",
      "LastName": "sample string 14",
      "Title": "sample string 15",
      "Email": "sample string 16",
      "IsEnabled": true,
      "last_action": "sample string 18"
    }
  ]
}

text/html

Sample:

{"Email":"sample string 1","Type":0,"SendFirmAdminWelcomeEmail":true,"AdminName":"sample string 3","TargetFirmInfo":[{"UserId":"sample string 1","user_id":2,"profile_id":3,"dateAdded":"2026-02-02T11:56:51.4146304+00:00","firmName":"sample string 4","emailOptin":"sample string 5","profileType":1,"linkedInAccessToken":"sample string 6","linkedInTokenExpDate":"sample string 7","linkedInProfileURL":"sample string 8","linkedInInfo":"sample string 9","profileIsLive":true,"imageName":"sample string 10","imageType":"sample string 11","currentPremiumLevel":1,"URLString":"sample string 12","status":true,"claimDateAdded":"2026-02-02T11:56:51.4146304+00:00","claimDateUpdated":"2026-02-02T11:56:51.4146304+00:00","parentID":1,"FirstName":"sample string 13","LastName":"sample string 14","Title":"sample string 15","Email":"sample string 16","IsEnabled":true,"last_action":"sample string 18"},{"UserId":"sample string 1","user_id":2,"profile_id":3,"dateAdded":"2026-02-02T11:56:51.4146304+00:00","firmName":"sample string 4","emailOptin":"sample string 5","profileType":1,"linkedInAccessToken":"sample string 6","linkedInTokenExpDate":"sample string 7","linkedInProfileURL":"sample string 8","linkedInInfo":"sample string 9","profileIsLive":true,"imageName":"sample string 10","imageType":"sample string 11","currentPremiumLevel":1,"URLString":"sample string 12","status":true,"claimDateAdded":"2026-02-02T11:56:51.4146304+00:00","claimDateUpdated":"2026-02-02T11:56:51.4146304+00:00","parentID":1,"FirstName":"sample string 13","LastName":"sample string 14","Title":"sample string 15","Email":"sample string 16","IsEnabled":true,"last_action":"sample string 18"}]}

application/xml, text/xml

Sample:

<AutoSubscribeEmailAddressBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JDSupraAPI.Models">
  <AdminName>sample string 3</AdminName>
  <Email>sample string 1</Email>
  <SendFirmAdminWelcomeEmail>true</SendFirmAdminWelcomeEmail>
  <TargetFirmInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/JDSupraAPI">
    <d2p1:FirmAdminInfoView>
      <d2p1:Email>sample string 16</d2p1:Email>
      <d2p1:FirstName>sample string 13</d2p1:FirstName>
      <d2p1:IsEnabled>true</d2p1:IsEnabled>
      <d2p1:LastName>sample string 14</d2p1:LastName>
      <d2p1:Title>sample string 15</d2p1:Title>
      <d2p1:URLString>sample string 12</d2p1:URLString>
      <d2p1:UserId>sample string 1</d2p1:UserId>
      <d2p1:claimDateAdded>2026-02-02T11:56:51.4146304+00:00</d2p1:claimDateAdded>
      <d2p1:claimDateUpdated>2026-02-02T11:56:51.4146304+00:00</d2p1:claimDateUpdated>
      <d2p1:currentPremiumLevel>1</d2p1:currentPremiumLevel>
      <d2p1:dateAdded>2026-02-02T11:56:51.4146304+00:00</d2p1:dateAdded>
      <d2p1:emailOptin>sample string 5</d2p1:emailOptin>
      <d2p1:firmName>sample string 4</d2p1:firmName>
      <d2p1:imageName>sample string 10</d2p1:imageName>
      <d2p1:imageType>sample string 11</d2p1:imageType>
      <d2p1:last_action>sample string 18</d2p1:last_action>
      <d2p1:linkedInAccessToken>sample string 6</d2p1:linkedInAccessToken>
      <d2p1:linkedInInfo>sample string 9</d2p1:linkedInInfo>
      <d2p1:linkedInProfileURL>sample string 8</d2p1:linkedInProfileURL>
      <d2p1:linkedInTokenExpDate>sample string 7</d2p1:linkedInTokenExpDate>
      <d2p1:parentID>1</d2p1:parentID>
      <d2p1:profileIsLive>true</d2p1:profileIsLive>
      <d2p1:profileType>1</d2p1:profileType>
      <d2p1:profile_id>3</d2p1:profile_id>
      <d2p1:status>true</d2p1:status>
      <d2p1:user_id>2</d2p1:user_id>
    </d2p1:FirmAdminInfoView>
    <d2p1:FirmAdminInfoView>
      <d2p1:Email>sample string 16</d2p1:Email>
      <d2p1:FirstName>sample string 13</d2p1:FirstName>
      <d2p1:IsEnabled>true</d2p1:IsEnabled>
      <d2p1:LastName>sample string 14</d2p1:LastName>
      <d2p1:Title>sample string 15</d2p1:Title>
      <d2p1:URLString>sample string 12</d2p1:URLString>
      <d2p1:UserId>sample string 1</d2p1:UserId>
      <d2p1:claimDateAdded>2026-02-02T11:56:51.4146304+00:00</d2p1:claimDateAdded>
      <d2p1:claimDateUpdated>2026-02-02T11:56:51.4146304+00:00</d2p1:claimDateUpdated>
      <d2p1:currentPremiumLevel>1</d2p1:currentPremiumLevel>
      <d2p1:dateAdded>2026-02-02T11:56:51.4146304+00:00</d2p1:dateAdded>
      <d2p1:emailOptin>sample string 5</d2p1:emailOptin>
      <d2p1:firmName>sample string 4</d2p1:firmName>
      <d2p1:imageName>sample string 10</d2p1:imageName>
      <d2p1:imageType>sample string 11</d2p1:imageType>
      <d2p1:last_action>sample string 18</d2p1:last_action>
      <d2p1:linkedInAccessToken>sample string 6</d2p1:linkedInAccessToken>
      <d2p1:linkedInInfo>sample string 9</d2p1:linkedInInfo>
      <d2p1:linkedInProfileURL>sample string 8</d2p1:linkedInProfileURL>
      <d2p1:linkedInTokenExpDate>sample string 7</d2p1:linkedInTokenExpDate>
      <d2p1:parentID>1</d2p1:parentID>
      <d2p1:profileIsLive>true</d2p1:profileIsLive>
      <d2p1:profileType>1</d2p1:profileType>
      <d2p1:profile_id>3</d2p1:profile_id>
      <d2p1:status>true</d2p1:status>
      <d2p1:user_id>2</d2p1:user_id>
    </d2p1:FirmAdminInfoView>
  </TargetFirmInfo>
  <Type>FirmAdmin</Type>
</AutoSubscribeEmailAddressBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>