POST api/v2.0/Blogs/CreateBlog

Create a new Blog.

Request Information

URI Parameters

None.

Body Parameters

Title: string. Body: string. CommunityKey: (Optional) To be supplied if the Blog should be associated with a specific Community. ViewPermissions: (Optional, Defaults to 'public') Can be one of - 'public', 'authenticated', 'members_only', 'my_contacts'. CommentPermissions: (Optional, Defaults to 'members_only') Can be one of - 'members_only', 'no_comments'. PublishImmediately: (Optional, Defaults to True) If False, the Blog will be Saved, but not Published.

CreateBlogRequest

Name	Type	Additional information
Title	string	None.
Body	string	None.
CommunityKey	globally unique identifier	None.
ViewPermissions	string	None.
CommentPermissions	string	None.
PublishImmediately	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "Body": "sample string 2",
  "CommunityKey": "175d5615-10f0-4492-8e04-cd3ba2eeaadc",
  "ViewPermissions": "sample string 3",
  "CommentPermissions": "sample string 4",
  "PublishImmediately": true
}

application/xml, text/xml

Sample:

<CreateBlogRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request">
  <Body>sample string 2</Body>
  <CommentPermissions>sample string 4</CommentPermissions>
  <CommunityKey>175d5615-10f0-4492-8e04-cd3ba2eeaadc</CommunityKey>
  <PublishImmediately>true</PublishImmediately>
  <Title>sample string 1</Title>
  <ViewPermissions>sample string 3</ViewPermissions>
</CreateBlogRequest>

Response Information

Resource Description

The newly created Blog.

Blog

Name	Type	Additional information
Author	ContactConcise	None.
BlogKey	globally unique identifier	None.
Community	Community	None.
CreatedOn	date	None.
BlogText	string	None.
IsPublished	boolean	None.
LinkToReadBlog	string	None.
PublishedOn	date	None.
BlogTitle	string	None.
UpdatedOn	date	None.
ViewPermission	string	None.
CommentPermission	string	None.
ViewCount	integer	None.
RatingCount	integer	None.
CommentCount	integer	None.
Comments	Collection of Comment	None.
RelatedLinks	Collection of RelatedLink	None.
ContactsWhoRecommend	Collection of ContactConcise	None.
AuthenticatedUserRecommends	boolean	None.
AuthenticatedUserFavorite	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Author": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "9c6d1c3e-c2ed-43a0-b158-400f320ae534",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "DisplayName": "sample string 6",
    "EmailAddress": "sample string 7",
    "ContactStatusCode": "sample string 8",
    "PrefixCode": "sample string 9",
    "UpdatedOn": "2026-02-04T11:57:04.03275Z",
    "UpdatedByContactKey": "cc96cdff-bcdc-462c-9e8a-4b6f3e4d0e94",
    "CompanyName": "sample string 12",
    "CompanyTitle": "sample string 13",
    "SuffixCode": "sample string 14",
    "Designation": "sample string 15",
    "LegacyContactKey": "sample string 16",
    "InformalName": "sample string 17",
    "MiddleName": "sample string 18",
    "IsCompany": true,
    "CompanyLegacyContactKey": "sample string 20",
    "AMSDirectoryOptOut": true,
    "HLDirectoryOptOut": true,
    "HLContactMeOptOut": true,
    "LargePictureUrl": "sample string 24",
    "AgreedToTermsDateTime": "2026-02-04T11:57:04.03275Z"
  },
  "BlogKey": "16435a20-19fb-4129-a9e0-395944747991",
  "Community": null,
  "CreatedOn": "2026-02-04T11:57:04.03275Z",
  "BlogText": "sample string 3",
  "IsPublished": true,
  "LinkToReadBlog": "sample string 5",
  "PublishedOn": "2026-02-04T11:57:04.03275Z",
  "BlogTitle": "sample string 7",
  "UpdatedOn": "2026-02-04T11:57:04.03275Z",
  "ViewPermission": "sample string 9",
  "CommentPermission": "sample string 10",
  "ViewCount": 11,
  "RatingCount": 12,
  "CommentCount": 13,
  "Comments": [
    {
      "CommentKey": "8e5b4ff7-4b73-4b67-b7e3-85bc79379ad7",
      "CommentBody": "sample string 2",
      "CommentAuthor": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "9c6d1c3e-c2ed-43a0-b158-400f320ae534",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "DisplayName": "sample string 6",
        "EmailAddress": "sample string 7",
        "ContactStatusCode": "sample string 8",
        "PrefixCode": "sample string 9",
        "UpdatedOn": "2026-02-04T11:57:04.03275Z",
        "UpdatedByContactKey": "cc96cdff-bcdc-462c-9e8a-4b6f3e4d0e94",
        "CompanyName": "sample string 12",
        "CompanyTitle": "sample string 13",
        "SuffixCode": "sample string 14",
        "Designation": "sample string 15",
        "LegacyContactKey": "sample string 16",
        "InformalName": "sample string 17",
        "MiddleName": "sample string 18",
        "IsCompany": true,
        "CompanyLegacyContactKey": "sample string 20",
        "AMSDirectoryOptOut": true,
        "HLDirectoryOptOut": true,
        "HLContactMeOptOut": true,
        "LargePictureUrl": "sample string 24",
        "AgreedToTermsDateTime": "2026-02-04T11:57:04.03275Z"
      },
      "IsOfficial": true,
      "ItemKey": "675e8215-9f29-4f67-9f0b-a69b119a4a60",
      "CreatedOn": "2026-02-04T11:57:04.0368058Z",
      "UpdatedOn": "2026-02-04T11:57:04.0368058Z"
    },
    {
      "CommentKey": "8e5b4ff7-4b73-4b67-b7e3-85bc79379ad7",
      "CommentBody": "sample string 2",
      "CommentAuthor": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "9c6d1c3e-c2ed-43a0-b158-400f320ae534",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "DisplayName": "sample string 6",
        "EmailAddress": "sample string 7",
        "ContactStatusCode": "sample string 8",
        "PrefixCode": "sample string 9",
        "UpdatedOn": "2026-02-04T11:57:04.03275Z",
        "UpdatedByContactKey": "cc96cdff-bcdc-462c-9e8a-4b6f3e4d0e94",
        "CompanyName": "sample string 12",
        "CompanyTitle": "sample string 13",
        "SuffixCode": "sample string 14",
        "Designation": "sample string 15",
        "LegacyContactKey": "sample string 16",
        "InformalName": "sample string 17",
        "MiddleName": "sample string 18",
        "IsCompany": true,
        "CompanyLegacyContactKey": "sample string 20",
        "AMSDirectoryOptOut": true,
        "HLDirectoryOptOut": true,
        "HLContactMeOptOut": true,
        "LargePictureUrl": "sample string 24",
        "AgreedToTermsDateTime": "2026-02-04T11:57:04.03275Z"
      },
      "IsOfficial": true,
      "ItemKey": "675e8215-9f29-4f67-9f0b-a69b119a4a60",
      "CreatedOn": "2026-02-04T11:57:04.0368058Z",
      "UpdatedOn": "2026-02-04T11:57:04.0368058Z"
    }
  ],
  "RelatedLinks": [
    {
      "RelatedLinkKey": "626484bb-70ac-4950-96bc-aa4d2ac5c548",
      "ItemKey": "eecaea76-5bb2-4fb6-a5be-f108884976f4",
      "Url": "sample string 3",
      "Contributor": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "9c6d1c3e-c2ed-43a0-b158-400f320ae534",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "DisplayName": "sample string 6",
        "EmailAddress": "sample string 7",
        "ContactStatusCode": "sample string 8",
        "PrefixCode": "sample string 9",
        "UpdatedOn": "2026-02-04T11:57:04.03275Z",
        "UpdatedByContactKey": "cc96cdff-bcdc-462c-9e8a-4b6f3e4d0e94",
        "CompanyName": "sample string 12",
        "CompanyTitle": "sample string 13",
        "SuffixCode": "sample string 14",
        "Designation": "sample string 15",
        "LegacyContactKey": "sample string 16",
        "InformalName": "sample string 17",
        "MiddleName": "sample string 18",
        "IsCompany": true,
        "CompanyLegacyContactKey": "sample string 20",
        "AMSDirectoryOptOut": true,
        "HLDirectoryOptOut": true,
        "HLContactMeOptOut": true,
        "LargePictureUrl": "sample string 24",
        "AgreedToTermsDateTime": "2026-02-04T11:57:04.03275Z"
      },
      "CreatedOn": "2026-02-04T11:57:04.0368058Z"
    },
    {
      "RelatedLinkKey": "626484bb-70ac-4950-96bc-aa4d2ac5c548",
      "ItemKey": "eecaea76-5bb2-4fb6-a5be-f108884976f4",
      "Url": "sample string 3",
      "Contributor": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "9c6d1c3e-c2ed-43a0-b158-400f320ae534",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "DisplayName": "sample string 6",
        "EmailAddress": "sample string 7",
        "ContactStatusCode": "sample string 8",
        "PrefixCode": "sample string 9",
        "UpdatedOn": "2026-02-04T11:57:04.03275Z",
        "UpdatedByContactKey": "cc96cdff-bcdc-462c-9e8a-4b6f3e4d0e94",
        "CompanyName": "sample string 12",
        "CompanyTitle": "sample string 13",
        "SuffixCode": "sample string 14",
        "Designation": "sample string 15",
        "LegacyContactKey": "sample string 16",
        "InformalName": "sample string 17",
        "MiddleName": "sample string 18",
        "IsCompany": true,
        "CompanyLegacyContactKey": "sample string 20",
        "AMSDirectoryOptOut": true,
        "HLDirectoryOptOut": true,
        "HLContactMeOptOut": true,
        "LargePictureUrl": "sample string 24",
        "AgreedToTermsDateTime": "2026-02-04T11:57:04.03275Z"
      },
      "CreatedOn": "2026-02-04T11:57:04.0368058Z"
    }
  ],
  "ContactsWhoRecommend": [
    {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "9c6d1c3e-c2ed-43a0-b158-400f320ae534",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "DisplayName": "sample string 6",
      "EmailAddress": "sample string 7",
      "ContactStatusCode": "sample string 8",
      "PrefixCode": "sample string 9",
      "UpdatedOn": "2026-02-04T11:57:04.03275Z",
      "UpdatedByContactKey": "cc96cdff-bcdc-462c-9e8a-4b6f3e4d0e94",
      "CompanyName": "sample string 12",
      "CompanyTitle": "sample string 13",
      "SuffixCode": "sample string 14",
      "Designation": "sample string 15",
      "LegacyContactKey": "sample string 16",
      "InformalName": "sample string 17",
      "MiddleName": "sample string 18",
      "IsCompany": true,
      "CompanyLegacyContactKey": "sample string 20",
      "AMSDirectoryOptOut": true,
      "HLDirectoryOptOut": true,
      "HLContactMeOptOut": true,
      "LargePictureUrl": "sample string 24",
      "AgreedToTermsDateTime": "2026-02-04T11:57:04.03275Z"
    },
    {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "9c6d1c3e-c2ed-43a0-b158-400f320ae534",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "DisplayName": "sample string 6",
      "EmailAddress": "sample string 7",
      "ContactStatusCode": "sample string 8",
      "PrefixCode": "sample string 9",
      "UpdatedOn": "2026-02-04T11:57:04.03275Z",
      "UpdatedByContactKey": "cc96cdff-bcdc-462c-9e8a-4b6f3e4d0e94",
      "CompanyName": "sample string 12",
      "CompanyTitle": "sample string 13",
      "SuffixCode": "sample string 14",
      "Designation": "sample string 15",
      "LegacyContactKey": "sample string 16",
      "InformalName": "sample string 17",
      "MiddleName": "sample string 18",
      "IsCompany": true,
      "CompanyLegacyContactKey": "sample string 20",
      "AMSDirectoryOptOut": true,
      "HLDirectoryOptOut": true,
      "HLContactMeOptOut": true,
      "LargePictureUrl": "sample string 24",
      "AgreedToTermsDateTime": "2026-02-04T11:57:04.03275Z"
    }
  ],
  "AuthenticatedUserRecommends": true,
  "AuthenticatedUserFavorite": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.