Merge pull request #4460 from braze-inc/kh/api_updates

Misc API updates
braze-inc · Nov 29, 2022 · 5ef6f27 · 5ef6f27
2 parents b870725 + 3b84fd2
commit 5ef6f27
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 8 deletions.
diff --git a/_docs/_api/endpoints/messaging/send_messages/post_send_transactional_message.md b/_docs/_api/endpoints/messaging/send_messages/post_send_transactional_message.md
@@ -23,6 +23,8 @@ Transactional Email is currently available as part of select Braze packages. Rea
 
 Similar to the [Send Triggered Campaign endpoint]({{site.baseurl}}/api/endpoints/messaging/send_messages/post_send_triggered_campaigns/), this campaign type allows you to house message content inside of the Braze dashboard while dictating when and to whom a message is sent via your API. Unlike the Send Triggered Campaign endpoint, which accepts an audience or segment to send messages to, a request to this endpoint must specify a single user either by `external_user_id` or `user_alias`, as this campaign type is purpose-built for 1:1 messaging of alerts like order confirmations or password resets.
 
+{% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#cec874e1-fa51-42a6-9a8d-7fc57d6a63bc {% endapiref %}
+
 ## Rate limit
 
 {% multi_lang_include rate_limits.md endpoint='transactional email' %}

diff --git a/_docs/_api/endpoints/scim/delete_existing_dashboard_user.md b/_docs/_api/endpoints/scim/delete_existing_dashboard_user.md
@@ -17,6 +17,8 @@ description: "This article outlines details about the Remove Existing User Accou
 
 This endpoint allows you to permanently delete an existing dashboard user by specifying the resource `id` returned by the SCIM [`POST`]({{site.baseurl}}/scim/post_create_user_account/) method. This is similar to deleting a user in the **Manage Users** section of the Braze dashboard. For information on how to obtain a SCIM token, visit [Automated user provisioning]({{site.baseurl}}/scim/automated_user_provisioning/).
 
+{% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#9c7c71ea-afd6-414a-99d1-4eb1fe274f16 {% endapiref %}
+
 ## Rate limit
 
 {% multi_lang_include rate_limits.md endpoint='delete dashboard user' %}
@@ -25,8 +27,8 @@ This endpoint allows you to permanently delete an existing dashboard user by spe
 
 ```json
 Content-Type: application/json
-Authorization: Bearer YOUR-SCIM-TOKEN-HERE
 X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
+Authorization: Bearer YOUR-SCIM-TOKEN-HERE
 ```
 
 ## Request parameters

diff --git a/_docs/_api/endpoints/scim/get_search_existing_dashboard_user.md b/_docs/_api/endpoints/scim/get_search_existing_dashboard_user.md
@@ -21,6 +21,8 @@ This endpoint allows you to look up an existing dashboard user account by specif
 
 For information on how to obtain a SCIM token, visit [Automated user provisioning]({{site.baseurl}}/scim/automated_user_provisioning/).
 
+{% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#5037d810-b822-4c54-bb51-f30470a42a95 {% endapiref %}
+
 ## Rate limit
 
 {% multi_lang_include rate_limits.md endpoint='look up dashboard user email' %}

diff --git a/_docs/_api/endpoints/scim/get_see_user_account_information.md b/_docs/_api/endpoints/scim/get_see_user_account_information.md
@@ -17,6 +17,8 @@ description: "This article outlines details about the Look Up an Existing Dashbo
 
 This endpoint allows you to look up an existing dashboard user account by specifying the resource `id` returned by the SCIM [`POST`]({{site.baseurl}}/scim/post_create_user_account/) method. For information on how to obtain a SCIM token, visit [Automated user provisioning]({{site.baseurl}}/scim/automated_user_provisioning/).
 
+{% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#3df40764-8f74-4532-aed3-ab8a6cb92122 {% endapiref %}
+
 ## Rate limit
 
 {% multi_lang_include rate_limits.md endpoint='look up dashboard user' %}
@@ -25,7 +27,7 @@ This endpoint allows you to look up an existing dashboard user account by specif
 ```
 Content-Type: application/json
 X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
-Authorization: Bearer YOUR-REST-API-KEY
+Authorization: Bearer YOUR-SCIM-TOKEN-HERE
 ```
 
 ## Request parameters

diff --git a/_docs/_api/endpoints/scim/post_create_user_account.md b/_docs/_api/endpoints/scim/post_create_user_account.md
@@ -18,6 +18,8 @@ description: "This article outlines details about the Create New Dashboard User
 
 This endpoint allows you to create a new dashboard user account by specifying email, given and family names, permissions (for setting permissions at the company, app group, and team level). For information on how to obtain a SCIM token, visit [Automated user provisioning]({{site.baseurl}}/scim/automated_user_provisioning/). 
 
+{% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#768a3c9d-ce1d-44fc-a0e4-d556b09f7aa3 {% endapiref %}
+
 ## Rate limit
 
 {% multi_lang_include rate_limits.md endpoint='create dashboard user' %}
@@ -26,7 +28,7 @@ This endpoint allows you to create a new dashboard user account by specifying em
 ```
 Content-Type: application/json
 X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
-Authorization: Bearer YOUR-REST-API-KEY
+Authorization: Bearer YOUR-SCIM-TOKEN-HERE
 ```
 ```
 {
@@ -71,7 +73,7 @@ Authorization: Bearer YOUR-REST-API-KEY
 curl --location --request POST 'https://rest.iad-01.braze.com/scim/v2/Users' \
 --header 'Content-Type: application/json' \
 --header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
---header 'Authorization: Bearer YOUR-API-KEY-HERE' \
+--header 'Authorization: Bearer YOUR-SCIM-TOKEN-HERE' \
 --data raw '{
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
     "userName": "user@test.com",

diff --git a/_docs/_api/endpoints/scim/put_update_existing_user_account.md b/_docs/_api/endpoints/scim/put_update_existing_user_account.md
@@ -19,6 +19,8 @@ This endpoint allows you to update an existing dashboard user account by specify
 
 For security reasons, `userName` (email address) cannot be updated through this endpoint. If you would like to change the `userName` (email address) for a user, contact [Support]({{site.baseurl}}/support_contact/).
 
+{% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#5f9a1642-988e-4011-8fb8-db4340ea1ac7 {% endapiref %}
+
 ## Rate limit
 
 {% multi_lang_include rate_limits.md endpoint='update dashboard user' %}
@@ -71,7 +73,7 @@ Authorization: Bearer YOUR-SCIM-TOKEN-HERE
 curl --location --request PUT 'https://rest.iad-01.braze.com/scim/v2/Users/dfa245b7-24195aec-887bb3ad-602b3340' \
 --header 'Content-Type: application/json' \
 --header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
---header 'Authorization: Bearer YOUR-API-KEY-HERE' \
+--header 'Authorization: Bearer YOUR-SCIM-TOKEN-HERE' \
 --data raw '{
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
     "name": {

diff --git a/.../endpoints/subscription_groups/post_update_user_subscription_group_status_v2.md b/.../endpoints/subscription_groups/post_update_user_subscription_group_status_v2.md
@@ -11,13 +11,25 @@ channel:
 ---
 
 {% api %}
-# Update user's subscription group status
+# Update user's subscription group status V2
 {% apimethod post %}
 /v2/subscription/status/set
 {% endapimethod %}
 
 Use this endpoint to batch update the subscription state of up to 50 users on the Braze dashboard. You can access a subscription group's `subscription_group_id` by navigating to the **Subscriptions Group** page.
 
+If you want to see examples or test this endpoint for **Email Subscription Groups**:
+
+{% apiref postman %}hhttps://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#b1b9a0e0-6329-4df2-a465-53347f410662 {% endapiref %}
+
+If you want to see examples or test this endpoint for **SMS Subscription Groups**:
+
+{% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#81a5fe65-588b-4b61-82d8-5ce68b681409 {% endapiref %}
+
+## Rate limit
+
+{% multi_lang_include rate_limits.md endpoint='subscription status set' %}
+
 ## Request body
 
 ```

diff --git a/_docs/_api/endpoints/templates/email_templates/post_create_email_template.md b/_docs/_api/endpoints/templates/email_templates/post_create_email_template.md
@@ -77,7 +77,7 @@ The following table lists possible returned errors and their associated troubles
 
 | Error | Troubleshooting |
 | --- | --- |
-| Template name is required |
+| Template name is required | Enter a template name. |
 | Tags must be an array | Tags must be formatted as an array of strings, for example `["marketing", "promotional", "transactional"]`. |
 | All tags must be strings | Make sure your tags are encapsulated in quotes (`""`). |
 | Some tags could not be found | To add a tag when creating an email template, the tag must already exist in Braze. |

diff --git a/_includes/rate_limits.md b/_includes/rate_limits.md
@@ -87,7 +87,7 @@ The daily maximum number of custom send identifiers that can be created via this
 
 <!---/subscription/status/set-->
 {% elsif include.endpoint == "subscription status set" %}
-For customers who onboarded with Braze on or after January 6, 2022, we apply a rate limit of 5,000 requests per minute to this endpoint as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
+For customers who onboarded with Braze on or after January 6, 2022, we apply a rate limit of 5,000 requests per minute shared across the `/subscription/status/set` and `/v2/subscription/status/set` endpoint as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
 
 {% endif %}