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.
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": "a16fdfd8-ebbb-4351-bbfb-4fc7e33aaeed", "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>a16fdfd8-ebbb-4351-bbfb-4fc7e33aaeed</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": "678cb4a1-9b44-4f9d-a9fd-da7752651c49", "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-01-15T07:21:52.6995696Z", "UpdatedByContactKey": "2451925a-f7fc-4dad-bcd5-361941229c2a", "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-01-15T07:21:52.6995696Z" }, "BlogKey": "196bde97-3843-4487-b03d-d88862372f28", "Community": null, "CreatedOn": "2025-01-15T07:21:52.6995696Z", "BlogText": "sample string 3", "IsPublished": true, "LinkToReadBlog": "sample string 5", "PublishedOn": "2025-01-15T07:21:52.6995696Z", "BlogTitle": "sample string 7", "UpdatedOn": "2025-01-15T07:21:52.6995696Z", "ViewPermission": "sample string 9", "CommentPermission": "sample string 10", "ViewCount": 11, "RatingCount": 12, "CommentCount": 13, "Comments": [ { "CommentKey": "0cbbdc80-a7be-4353-8a7e-da196d794f5c", "CommentBody": "sample string 2", "CommentAuthor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "678cb4a1-9b44-4f9d-a9fd-da7752651c49", "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-01-15T07:21:52.6995696Z", "UpdatedByContactKey": "2451925a-f7fc-4dad-bcd5-361941229c2a", "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-01-15T07:21:52.6995696Z" }, "IsOfficial": true, "ItemKey": "c021fcbe-bd22-483d-8b2c-eb1e8c3ebd92", "CreatedOn": "2025-01-15T07:21:52.6995696Z", "UpdatedOn": "2025-01-15T07:21:52.6995696Z" }, { "CommentKey": "0cbbdc80-a7be-4353-8a7e-da196d794f5c", "CommentBody": "sample string 2", "CommentAuthor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "678cb4a1-9b44-4f9d-a9fd-da7752651c49", "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-01-15T07:21:52.6995696Z", "UpdatedByContactKey": "2451925a-f7fc-4dad-bcd5-361941229c2a", "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-01-15T07:21:52.6995696Z" }, "IsOfficial": true, "ItemKey": "c021fcbe-bd22-483d-8b2c-eb1e8c3ebd92", "CreatedOn": "2025-01-15T07:21:52.6995696Z", "UpdatedOn": "2025-01-15T07:21:52.6995696Z" } ], "RelatedLinks": [ { "RelatedLinkKey": "0b511b0b-3937-4fb0-99ef-887007eb2836", "ItemKey": "77a8c345-0676-495c-a367-024903dcd6a5", "Url": "sample string 3", "Contributor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "678cb4a1-9b44-4f9d-a9fd-da7752651c49", "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-01-15T07:21:52.6995696Z", "UpdatedByContactKey": "2451925a-f7fc-4dad-bcd5-361941229c2a", "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-01-15T07:21:52.6995696Z" }, "CreatedOn": "2025-01-15T07:21:52.6995696Z" }, { "RelatedLinkKey": "0b511b0b-3937-4fb0-99ef-887007eb2836", "ItemKey": "77a8c345-0676-495c-a367-024903dcd6a5", "Url": "sample string 3", "Contributor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "678cb4a1-9b44-4f9d-a9fd-da7752651c49", "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-01-15T07:21:52.6995696Z", "UpdatedByContactKey": "2451925a-f7fc-4dad-bcd5-361941229c2a", "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-01-15T07:21:52.6995696Z" }, "CreatedOn": "2025-01-15T07:21:52.6995696Z" } ], "ContactsWhoRecommend": [ { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "678cb4a1-9b44-4f9d-a9fd-da7752651c49", "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-01-15T07:21:52.6995696Z", "UpdatedByContactKey": "2451925a-f7fc-4dad-bcd5-361941229c2a", "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-01-15T07:21:52.6995696Z" }, { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "678cb4a1-9b44-4f9d-a9fd-da7752651c49", "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-01-15T07:21:52.6995696Z", "UpdatedByContactKey": "2451925a-f7fc-4dad-bcd5-361941229c2a", "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-01-15T07:21:52.6995696Z" } ], "AuthenticatedUserRecommends": true, "AuthenticatedUserFavorite": true }
application/xml
Sample not available.
text/xml
Sample not available.