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.
CreateBlogRequestName | Description | 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
{ "Title": "sample string 1", "Body": "sample string 2", "CommunityKey": "ba308517-a386-4b60-9079-fb1bc6b0e7da", "ViewPermissions": "sample string 3", "CommentPermissions": "sample string 4", "PublishImmediately": true }
application/xml, text/xml
<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>ba308517-a386-4b60-9079-fb1bc6b0e7da</CommunityKey> <PublishImmediately>true</PublishImmediately> <Title>sample string 1</Title> <ViewPermissions>sample string 3</ViewPermissions> </CreateBlogRequest>
Response Information
Resource Description
The newly created Blog.
BlogName | Description | 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
{ "Author": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3a495e55-fbc8-45f8-ba73-91bf4d331851", "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": "2025-07-22T12:41:44.2643925Z", "UpdatedByContactKey": "ed36ece0-f784-4678-9df8-ec6c9e4de030", "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": "2025-07-22T12:41:44.2643925Z" }, "BlogKey": "6ab3b16a-5ba5-4a51-806f-a8863b04dd4c", "Community": null, "CreatedOn": "2025-07-22T12:41:44.2643925Z", "BlogText": "sample string 3", "IsPublished": true, "LinkToReadBlog": "sample string 5", "PublishedOn": "2025-07-22T12:41:44.2643925Z", "BlogTitle": "sample string 7", "UpdatedOn": "2025-07-22T12:41:44.2643925Z", "ViewPermission": "sample string 9", "CommentPermission": "sample string 10", "ViewCount": 11, "RatingCount": 12, "CommentCount": 13, "Comments": [ { "CommentKey": "75baa2d0-a415-496b-895e-74aeeeb478af", "CommentBody": "sample string 2", "CommentAuthor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3a495e55-fbc8-45f8-ba73-91bf4d331851", "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": "2025-07-22T12:41:44.2643925Z", "UpdatedByContactKey": "ed36ece0-f784-4678-9df8-ec6c9e4de030", "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": "2025-07-22T12:41:44.2643925Z" }, "IsOfficial": true, "ItemKey": "a43fcb26-e746-407f-b8d7-b09db2cff015", "CreatedOn": "2025-07-22T12:41:44.2643925Z", "UpdatedOn": "2025-07-22T12:41:44.2643925Z" }, { "CommentKey": "75baa2d0-a415-496b-895e-74aeeeb478af", "CommentBody": "sample string 2", "CommentAuthor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3a495e55-fbc8-45f8-ba73-91bf4d331851", "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": "2025-07-22T12:41:44.2643925Z", "UpdatedByContactKey": "ed36ece0-f784-4678-9df8-ec6c9e4de030", "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": "2025-07-22T12:41:44.2643925Z" }, "IsOfficial": true, "ItemKey": "a43fcb26-e746-407f-b8d7-b09db2cff015", "CreatedOn": "2025-07-22T12:41:44.2643925Z", "UpdatedOn": "2025-07-22T12:41:44.2643925Z" } ], "RelatedLinks": [ { "RelatedLinkKey": "47dab791-3ee3-4106-acbe-62570a0b3d33", "ItemKey": "f53c7e51-1551-4a9a-8c85-38d86c43b445", "Url": "sample string 3", "Contributor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3a495e55-fbc8-45f8-ba73-91bf4d331851", "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": "2025-07-22T12:41:44.2643925Z", "UpdatedByContactKey": "ed36ece0-f784-4678-9df8-ec6c9e4de030", "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": "2025-07-22T12:41:44.2643925Z" }, "CreatedOn": "2025-07-22T12:41:44.2643925Z" }, { "RelatedLinkKey": "47dab791-3ee3-4106-acbe-62570a0b3d33", "ItemKey": "f53c7e51-1551-4a9a-8c85-38d86c43b445", "Url": "sample string 3", "Contributor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3a495e55-fbc8-45f8-ba73-91bf4d331851", "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": "2025-07-22T12:41:44.2643925Z", "UpdatedByContactKey": "ed36ece0-f784-4678-9df8-ec6c9e4de030", "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": "2025-07-22T12:41:44.2643925Z" }, "CreatedOn": "2025-07-22T12:41:44.2643925Z" } ], "ContactsWhoRecommend": [ { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3a495e55-fbc8-45f8-ba73-91bf4d331851", "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": "2025-07-22T12:41:44.2643925Z", "UpdatedByContactKey": "ed36ece0-f784-4678-9df8-ec6c9e4de030", "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": "2025-07-22T12:41:44.2643925Z" }, { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3a495e55-fbc8-45f8-ba73-91bf4d331851", "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": "2025-07-22T12:41:44.2643925Z", "UpdatedByContactKey": "ed36ece0-f784-4678-9df8-ec6c9e4de030", "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": "2025-07-22T12:41:44.2643925Z" } ], "AuthenticatedUserRecommends": true, "AuthenticatedUserFavorite": true }
application/xml
Sample not available.
text/xml
Sample not available.