POST api/v1.0/Blogs/AddRelatedLink?blogKey={blogKey}
Adds the specified URL as a RelatedLink to the specified Blog.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| blogKey |
BlogKey of the Blog to which the Related Link should be added. |
globally unique identifier |
Required |
Body Parameters
URL to add as the Related Link.
RelatedLinkRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Url | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Url": "sample string 1"
}
application/xml, text/xml
Sample:
<RelatedLinkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request"> <Url>sample string 1</Url> </RelatedLinkRequest>
Response Information
Resource Description
RelatedLink| Name | Description | Type | Additional information |
|---|---|---|---|
| RelatedLinkKey | globally unique identifier |
None. |
|
| ItemKey | globally unique identifier |
None. |
|
| Url | string |
None. |
|
| Contributor | ContactConcise |
None. |
|
| CreatedOn | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"RelatedLinkKey": "77137c7d-ff02-404b-807c-07179db20c1d",
"ItemKey": "eb596e58-4734-462e-8034-4c22b0573d7e",
"Url": "sample string 3",
"Contributor": {
"LinkToProfile": "sample string 1",
"PictureUrl": "sample string 2",
"ContactKey": "9a92f9ce-014f-47f6-802c-fd5f8cf52aab",
"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-11-05T11:37:04.702719Z",
"UpdatedByContactKey": "0164f66c-94f9-447b-9708-c225cbd541c0",
"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-11-05T11:37:04.702719Z"
},
"CreatedOn": "2025-11-05T11:37:04.702719Z"
}
application/xml, text/xml
Sample:
<RelatedLink xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
<Contributor>
<AMSDirectoryOptOut>true</AMSDirectoryOptOut>
<AgreedToTermsDateTime>2025-11-05T06:37:04.702719-05:00</AgreedToTermsDateTime>
<CompanyLegacyContactKey>sample string 20</CompanyLegacyContactKey>
<CompanyName>sample string 12</CompanyName>
<CompanyTitle>sample string 13</CompanyTitle>
<ContactKey>9a92f9ce-014f-47f6-802c-fd5f8cf52aab</ContactKey>
<ContactStatusCode>sample string 8</ContactStatusCode>
<Designation>sample string 15</Designation>
<DisplayName>sample string 6</DisplayName>
<EmailAddress>sample string 7</EmailAddress>
<FirstName>sample string 4</FirstName>
<HLContactMeOptOut>true</HLContactMeOptOut>
<HLDirectoryOptOut>true</HLDirectoryOptOut>
<InformalName>sample string 17</InformalName>
<IsCompany>true</IsCompany>
<LargePictureUrl>sample string 24</LargePictureUrl>
<LastName>sample string 5</LastName>
<LegacyContactKey>sample string 16</LegacyContactKey>
<LinkToProfile>sample string 1</LinkToProfile>
<MiddleName>sample string 18</MiddleName>
<PictureUrl>sample string 2</PictureUrl>
<PrefixCode>sample string 9</PrefixCode>
<SuffixCode>sample string 14</SuffixCode>
<UpdatedByContactKey>0164f66c-94f9-447b-9708-c225cbd541c0</UpdatedByContactKey>
<UpdatedOn>2025-11-05T06:37:04.702719-05:00</UpdatedOn>
</Contributor>
<CreatedOn>2025-11-05T06:37:04.702719-05:00</CreatedOn>
<ItemKey>eb596e58-4734-462e-8034-4c22b0573d7e</ItemKey>
<RelatedLinkKey>77137c7d-ff02-404b-807c-07179db20c1d</RelatedLinkKey>
<Url>sample string 3</Url>
</RelatedLink>