Sitecore Content Hub REST API: CRUD Operations on Content Hub Using Postman
Published: 17 November 2026

Sitecore Content Hub provides REST APIs that allow developers to manage content entities programmatically. Using these APIs, developers can create new content, retrieve existing records, update properties, and delete entities without manually performing these operations in the Content Hub user interface.
We will cover authentication using the OAuth token endpoint, followed by the GET, POST, PUT, and DELETE operations using the Content Hub Entities API.
Prerequisites
Before starting, ensure that you have:
- Access to a Sitecore Content Hub environment.
- A Blog entity definition configured in Content Hub.
- Valid Content Hub username and password, client ID, and client secret.
- Permissions to create, read, update, and delete the relevant entities.
- Postman installed.
Authenticate with the Content Hub OAuth API
Before performing CRUD operations, obtain an access token from the Content Hub authentication endpoint.
Request configuration
O-Auth: POST
/oauth/token
Description | OAuth is an open standard for authorization. It allows one program to authorize another program to make changes on behalf of an account holder or end-user. |
Method | POST |
Endpoint | {sitecore content hub url} |
Resource | /oauth/token |
Header | Content-Type: application/x-www-form-urlencoded |
Parameters | NA |
Curl | curl --location '{sitecore content hub url}/oauth/token' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'username=*** ' \ --data-urlencode 'password=*** \ --data-urlencode 'client_id=*** \ --data-urlencode 'client_secret=*** ' \ --data-urlencode 'grant_type=password' |
Sample Input Body |
username:*** |
Sample Output Body | { "scope": "offline_access", "token_type": "Bearer", "access_token": "***", "expires_in": 3600, "refresh_token": "***" } |
The actual response fields and expiration value depend on the authentication configuration.
The following endpoints will be used to manage Blog entities.
Operation | HTTP method | Endpoint |
Create a blog | POST | /api/entities |
Retrieve a blog | GET | /api/entities/{id} |
Update a blog | PUT | /api/entities/{id} |
Delete a blog | DELETE | /api/entities/{id} |
The entity ID identifies the specific Blog entity to retrieve, update, or delete.
Sitecore Content Hub exposes resource links through its REST API. Confirm the exact resource URLs and payload requirements against the API documentation and entity definition available in your environment.
Create a Blog entity using POST
The POST operation creates a new Blog entity in Content Hub.
For this example, we will create a blog titled Getting Started with Sitecore Content Hub REST API.
Request configuration
The entity definition URL and property names above are examples. Replace M.Blog and the property names with the actual entity definition and fields configured in your Content Hub environment.
The payload identifies the type of entity to create and supplies its property values. Depending on your entity definition and API contract, additional metadata or a different representation may be required.
Description | Post call to add new entity. |
Method | POST |
Endpoint | {sitecore content hub url} |
Resource | /api/entities |
Header |
Authorization: Bearer {access_ token} |
Parameters | NA |
Curl | curl --location '{sitecore content hub url}/api/entities' \ --header 'Content-Type: application/json' \ --header 'Authorization: ••••••' \ --data '{ "properties": { "Blog_Title": "Getting Started with Sitecore Content Hub REST API", "Blog_Description": "Learn how to create, retrieve, update, and delete blog content using the Sitecore Content Hub REST API.", "Blog_Author": "John Smith" "Content.Name": "Blog", }, "entitydefinition": { "title": "The entity definition for this entity" } }'
|
Sample Output Body | { "id": 1532280, "identifier": "Zpbp2ZSiRaWqfGQ5dQpk8A" } |
Save the returned entity ID because it will be used in the subsequent operations.
Retrieve Blog content using GET
The GET operation retrieves an existing entity from Content Hub.
Description | Get call to retrieve list of Parenting |
Method | GET |
Endpoint | {sitecore content hub url} |
Resource | /api/entities/{id} |
Header |
Authorization: Bearer {access_ token} |
Parameters | NA |
Curl | curl --location '{sitecore content hub url}/api/entities/1532280' \ --header 'Authorization: ••••••' |
Snippet | var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "{sitecore content hub url}/api/entities/1532280"); request.Headers.Add("Authorization", "••••••"); var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());
|
Sample Input Body | NA |
Sample Output Body | { "id": 1532280, "identifier": "Zpbp2ZSiRaWqfGQ5dQpk8A", "properties": { "Blog_Title": "Getting Started with Sitecore Content Hub REST API", "Blog_Description": "Learn how to create, retrieve, update, and delete blog content using the Sitecore Content Hub REST API.", "Blog_Author": "John Smith" } }
|
Update an existing Blog entity using PUT
The PUT operation updates an existing Blog entity using its ID.
Suppose we want to change the blog title and description.
Description | Put call to update existing entity |
Method | PUT |
Endpoint | {sitecore content hub url} |
Resource | /api/entities/{id} |
Header |
Authorization: Bearer {access_ token} |
Parameters | NA |
Curl | curl --location --request PUT '{sitecore content hub url}/api/entities/1532280' \ --header 'Content-Type: application/json' \ --header 'Authorization: ••••••' \ --data '{ "id": 1532280, "identifier": "Zpbp2ZSiRaWqfGQ5dQpk8A", "cultures": [ "en-US" ], "properties": { "Blog_Title": "Getting Started with Sitecore Content Hub REST API", "Blog_Description": "Learn how to create, retrieve, update, and delete blog content using the Sitecore Content Hub REST API.",
}, "entitydefinition": { "title": "The entity definition for this entity" } }' |
Sample Output Body | 200 Ok |
After submitting the request successfully, execute the GET request again using the same entity ID to confirm that the updated properties have been saved.
Delete a Blog entity using DELETE
The DELETE operation removes an existing Blog entity from Content Hub.
Description | Delete call to delete an entity |
Method | DELETE |
Endpoint | {sitecore content hub url} |
Resource | /api/entities/{id} |
Header |
Authorization: Bearer {access_ token} |
Parameters | NA |
Curl | curl --location --request DELETE '{sitecore content hub url}/api/entities/1532280' \ --header 'Authorization: ••••••' |
Snippet | var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "{sitecore content hub url}/api/entities/1532280"); request.Headers.Add("Authorization", "••••••"); var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync()); |
Sample Output Body | 200 OK
|
You can then issue a GET request to verify whether the entity remains available.
Before deleting content in production, confirm that permanent deletion is appropriate and check whether other entities, relationships, or integrations depend on the record.
Common API errors and troubleshooting
HTTP status | Possible cause | Recommended action |
400 Bad Request | Invalid payload or missing required properties | Validate the JSON and entity definition |
401 Unauthorized | Missing, invalid, or expired token | Request a valid token and check the authentication configuration |
403 Forbidden | Insufficient permissions | Review Content Hub access policies |
404 Not Found | Incorrect entity ID or resource URL | Verify the entity ID and endpoint |
409 Conflict | Conflicting resource state | Inspect the response and resolve the conflict |
429 Too Many Requests | API throttling | Respect Retry-After when present and apply backoff |
The precise status codes and error messages depend on the operation and environment.
For authentication issues, verify the token endpoint, form-encoded body parameters, grant type, client credentials, and token usage.
For entity operations, verify the entity definition, field names, entity ID, and request payload.
Best practices
- Use environment variables. Store the base URL, credentials, client ID, client secret, and token in Postman environment variables rather than hardcoding them into every request.
- Protect sensitive information. Do not share real authentication credentials or access tokens in public documentation.
- Validate entity properties. Confirm that property names and field types match the Blog entity definition.
- Verify successful operations. After creation or update, retrieve the entity and validate its values.
- Handle token expiration. Obtain a fresh token when required by the authentication configuration.
- Follow API resource links. Use links returned by Content Hub where appropriate to avoid assumptions about resource URLs.
- Handle throttling. Implement appropriate retry behavior for automated integrations and avoid retrying create requests blindly.
- Use deletion carefully. Validate the entity ID and business requirements before permanently deleting production content.
Conclusion
The Sitecore Content Hub REST API enables developers to manage content programmatically through standard HTTP operations.
Using Postman, we can test the complete CRUD lifecycle.
The OAuth token endpoint provides the authentication mechanism for the subsequent requests. Once authentication and entity payloads are configured correctly, these operations can serve as the foundation for more advanced integrations with .NET applications, websites, and external content management systems.

Mitesh Patel || Chief Technology Officer (CTO) | ADDACT
Sitecore AI Certified || XMCloud || OrderCloud Certified
Mitesh Patel is the Chief Technology Officer (CTO) at Addact with 12+ years of experience in enterprise CMS, digital experience platforms, and cloud-native application development. He specializes in Sitecore, Contentful, Strapi, Kentico, Umbraco, Contentstack, and .NET, helping organizations build scalable, secure, and future-ready digital solutions through modern CMS, headless architectures, AI-driven experiences, and cloud technologies.