Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add additional fields to the users/track response documentation #52

Merged
merged 2 commits into from
Apr 16, 2019
Merged

Add additional fields to the users/track response documentation #52

merged 2 commits into from
Apr 16, 2019

Conversation

dulle-braze
Copy link
Contributor

Pull Request/Issue Resolution

Description of Change:

The documentation for the response returned from users/track endpoint was incomplete. This adds additional fields returned by the endpoint to the documentation.

This can be merged at any time.

Reason for Change:

Closes #ISSUE_NUMBER_HERE

PR Checklist

  • Ensure you have completed our CLA.
  • Tag @EmilyNecciai as a reviewer when the your work is done and ready to be reviewed for merge.
  • Consult the Docs Text Formatting Guide to be sure you're utilizing the proper markdown formatting.
  • Consult the Docs Writing Style Guide & Best Practices to be sure you're aligning with our voice and other style best practices.
  • Preview your deployed changes to confirm that none of your changes break production. Pay close attention to links and images.
  • Tag others as Reviewers as necessary.
  • If you have modified any links, be sure to add redirects to config/nginx.conf.erb.

@dulle-braze dulle-braze requested a review from a team as a code owner April 16, 2019 15:11
@cla-bot cla-bot bot added the cla-signed label Apr 16, 2019
@appboyci appboyci temporarily deployed to braze-docs-staging-pr-52 April 16, 2019 15:11 Inactive
toksfifo
toksfifo reviewed Apr 16, 2019
View reviewed changes
_docs/_developer_guide/rest_api/user_data.md Outdated
@@ -305,7 +305,10 @@ Successful messages will be met with the following response:

```json
{
"message" : "success"
"message" : "success",
"attributes_processed" : <if attributes are included in the request, this will return an integer of the number of attributes that were processed>,
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we should say something like "queued to be processed" like in /users/delete.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, that's better. Will update.

EmilyNecciai
EmilyNecciai approved these changes Apr 16, 2019
View reviewed changes
Copy link
Contributor

@EmilyNecciai EmilyNecciai left a comment

Choose a reason for hiding this comment

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

lgtm

@EmilyNecciai EmilyNecciai merged commit 1b0acb9 into develop Apr 16, 2019
@EmilyNecciai EmilyNecciai deleted the feature-users-track-response branch April 16, 2019 20:13
@EmilyNecciai EmilyNecciai mentioned this pull request Apr 16, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@toksfifo toksfifo toksfifo left review comments

@EmilyNecciai EmilyNecciai EmilyNecciai approved these changes

Assignees
No one assigned
Labels
cla-signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dulle-braze @toksfifo @EmilyNecciai @appboyci