Skip to content

Conversation

@rohit369-hs
Copy link
Collaborator

Add bulk api details to dev docs.

@vercel
Copy link

vercel bot commented Mar 5, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
helpshift-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 12, 2025 7:06am

abhi-1123
abhi-1123 previously approved these changes Mar 5, 2025
Copy link
Collaborator

@abhi-1123 abhi-1123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rohit369-hs rohit369-hs requested a review from KrishnaMB-PM March 5, 2025 11:45
Copy link
Collaborator

@hs-shantanu hs-shantanu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of a section under Getting Started, there should be a separate page for Identity APIs, with more details than just API endpoints.


| Command | Request URL | Description |
| ------- | -------------------------------------------------------------------------- | ------------------------------------ |
| POST | https://api.helpshift.com/v1/ `<domain>` /bulk_actions/ | create bulk tasks |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be /identity/bulk_actions/

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. @hs-shantanu : I had added the endpoints here and was planning to add the details in apidocs. So, should we add all the api details in a separate page and skip the addition in apidocs?

| GET | https://api.helpshift.com/v1/ `<domain>` /bulk_actions/`{task-id}` | retrive task information |
| GET | https://api.helpshift.com/v1/ `<domain>` /bulk_actions/`{task-id}`/errors | retrive task errors (if any) |
| GET | https://api.helpshift.com/v1/ `<domain>` /bulk_actions/`{task-id}`/results | retrive task results (if any) |
| GET | https://api.helpshift.com/v1/ `<domain>` /bulk_actions/`{task-id}`/results | retrive task results |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: retrive-> retrieve

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants