POST api/v1.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 'authenticated') Can be one of - 'authenticated', 'members_only', 'my_contacts', 'no_comments'., PublishImmediately: (Optional, Defaults to True) If False, the Blog will be Saved, but not Published.

CreateBlogRequest
NameDescriptionTypeAdditional 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": "093f7143-84e6-4846-aca8-3342d631e754",
  "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>093f7143-84e6-4846-aca8-3342d631e754</CommunityKey>
  <PublishImmediately>true</PublishImmediately>
  <Title>sample string 1</Title>
  <ViewPermissions>sample string 3</ViewPermissions>
</CreateBlogRequest>

Response Information

Resource Description

The newly created Blog.

Blog
NameDescriptionTypeAdditional information
Author

ContactConcise

None.

BlogKey

globally unique identifier

None.

Community

None.

Response Formats

application/json, text/json

Sample:
{
  "Author": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "6215013c-467c-4d6d-b438-d233f01aa154",
    "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": "2024-04-13T09:00:43.7009357Z",
    "UpdatedByContactKey": "53ce2fcf-21fb-4e72-955f-b4864f1761e5",
    "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": "2024-04-13T09:00:43.7009357Z"
  },
  "BlogKey": "e3b94ecc-faea-4501-938f-718b0434e0c3",
  "Community": null,
  "CreatedOn": "2024-04-13T09:00:43.7009357Z",
  "BlogText": "sample string 3",
  "IsPublished": true,
  "LinkToReadBlog": "sample string 5",
  "PublishedOn": "2024-04-13T09:00:43.7009357Z",
  "BlogTitle": "sample string 7",
  "UpdatedOn": "2024-04-13T09:00:43.7009357Z",
  "ViewPermission": "sample string 9",
  "CommentPermission": "sample string 10",
  "ViewCount": 11,
  "RatingCount": 12,
  "CommentCount": 13,
  "Comments": [
    {
      "CommentKey": "bc71a53a-af95-4df1-b31f-a140eb4aa8a0",
      "CommentBody": "sample string 2",
      "CommentAuthor": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "6215013c-467c-4d6d-b438-d233f01aa154",
        "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": "2024-04-13T09:00:43.7009357Z",
        "UpdatedByContactKey": "53ce2fcf-21fb-4e72-955f-b4864f1761e5",
        "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": "2024-04-13T09:00:43.7009357Z"
      },
      "IsOfficial": true,
      "ItemKey": "927a220c-a946-4e66-9e66-9bf29b20725a",
      "CreatedOn": "2024-04-13T09:00:43.7009357Z",
      "UpdatedOn": "2024-04-13T09:00:43.7009357Z"
    },
    {
      "CommentKey": "bc71a53a-af95-4df1-b31f-a140eb4aa8a0",
      "CommentBody": "sample string 2",
      "CommentAuthor": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "6215013c-467c-4d6d-b438-d233f01aa154",
        "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": "2024-04-13T09:00:43.7009357Z",
        "UpdatedByContactKey": "53ce2fcf-21fb-4e72-955f-b4864f1761e5",
        "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": "2024-04-13T09:00:43.7009357Z"
      },
      "IsOfficial": true,
      "ItemKey": "927a220c-a946-4e66-9e66-9bf29b20725a",
      "CreatedOn": "2024-04-13T09:00:43.7009357Z",
      "UpdatedOn": "2024-04-13T09:00:43.7009357Z"
    }
  ],
  "RelatedLinks": [
    {
      "RelatedLinkKey": "ca607195-9e4f-459b-90aa-f4919b1034c5",
      "ItemKey": "11a2ca10-54fa-4a0d-b91e-c65b354898bd",
      "Url": "sample string 3",
      "Contributor": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "6215013c-467c-4d6d-b438-d233f01aa154",
        "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": "2024-04-13T09:00:43.7009357Z",
        "UpdatedByContactKey": "53ce2fcf-21fb-4e72-955f-b4864f1761e5",
        "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": "2024-04-13T09:00:43.7009357Z"
      },
      "CreatedOn": "2024-04-13T09:00:43.7009357Z"
    },
    {
      "RelatedLinkKey": "ca607195-9e4f-459b-90aa-f4919b1034c5",
      "ItemKey": "11a2ca10-54fa-4a0d-b91e-c65b354898bd",
      "Url": "sample string 3",
      "Contributor": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "6215013c-467c-4d6d-b438-d233f01aa154",
        "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": "2024-04-13T09:00:43.7009357Z",
        "UpdatedByContactKey": "53ce2fcf-21fb-4e72-955f-b4864f1761e5",
        "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": "2024-04-13T09:00:43.7009357Z"
      },
      "CreatedOn": "2024-04-13T09:00:43.7009357Z"
    }
  ],
  "ContactsWhoRecommend": [
    {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "6215013c-467c-4d6d-b438-d233f01aa154",
      "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": "2024-04-13T09:00:43.7009357Z",
      "UpdatedByContactKey": "53ce2fcf-21fb-4e72-955f-b4864f1761e5",
      "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": "2024-04-13T09:00:43.7009357Z"
    },
    {
      "LinkToProfile": "sample string 1",
      "PictureUrl": "sample string 2",
      "ContactKey": "6215013c-467c-4d6d-b438-d233f01aa154",
      "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": "2024-04-13T09:00:43.7009357Z",
      "UpdatedByContactKey": "53ce2fcf-21fb-4e72-955f-b4864f1761e5",
      "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": "2024-04-13T09:00:43.7009357Z"
    }
  ],
  "AuthenticatedUserRecommends": true,
  "AuthenticatedUserFavorite": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.