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.

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

Minor style edits for Postman audit #8573

Merged
merged 1 commit into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The following table lists possible returned errors and their associated troubles
| `ids-too-large` | Item IDs can't be more than 250 characters. |
| `ids-not-unique` | Check that the item IDs are unique in the request. |
| `ids-not-strings` | Item IDs must be of type string. |
| `items-missing-ids` | There are items that do not have item IDs. Check that each item has an item ID. |
| `items-missing-ids` | Some items don't have item IDs. Check that each item has an item ID. |
| `invalid-ids` | Item IDs can only include letters, numbers, hyphens, and underscores. |
| `request-includes-too-many-items` | Your request has too many items. The item limit per request is 50. |
{: .reset-td-br-1 .reset-td-br-2 role="presentation" }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The following table lists possible returned errors and their associated troubles
| `invalid-ids` | Item IDs can only include letters, numbers, hyphens, and underscores. |
| `invalid-fields` | Confirm that all fields you are sending in the API request already exist in the catalog. This is not related to the ID field mentioned in the error. |
| `invalid-keys-in-value-object` | Item object keys can't include `.` or `$`. |
| `items-missing-ids` | There are items that do not have item IDs. Check that each item has an item ID. |
| `items-missing-ids` | Some items don't have item IDs. Check that each item has an item ID. |
| `item-array-invalid` | `items` must be an array of objects. |
| `items-too-large` | Item values can't exceed 5,000 characters. |
| `request-includes-too-many-items` | Your request has too many items. The item limit per request is 50. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ The following table lists possible returned errors and their associated troubles
| `invalid-fields` | Confirm that all fields you are sending in the API request already exist in the catalog. This is not related to the ID field mentioned in the error. |
| `invalid-keys-in-value-object` | Item object keys can't include `.` or `$`. |
| `item-array-invalid` | `items` must be an array of objects. |
| `items-missing-ids` | There are items that do not have item IDs. Check that each item has an item ID. |
| `items-missing-ids` | Some items don't have item IDs. Check that each item has an item ID. |
| `items-too-large` | Item values can't exceed 5,000 characters. |
| `request-includes-too-many-items` | Your request has too many items. The item limit per request is 50. |
| `too-deep-nesting-in-value-object` | Item objects can't have more than 50 levels of nesting. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ The following table lists possible returned errors and their associated troubles
| `ids-not-unique` | Check that each item ID is unique. |
| `ids-too-large` | Character limit for each item ID is 250 characters. |
| `item-array-invalid` | `items` must be an array of objects. |
| `items-missing-ids` | Confirm that each item has an ID. |
| `items-missing-ids` | Some items don't have item IDs. Confirm that each item has an ID. |
| `items-too-large` | Item values can't exceed 5,000 characters. |
| `invalid-ids` | Supported characters for item ID names are letters, numbers, hyphens, and underscores. |
| `invalid-fields` | Confirm that all fields you are sending in the API request already exist in the catalog. This is not related to the ID field mentioned in the error. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ description: "This article outlines details about the Edit catalog item Braze en

To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key/) with the `catalogs.update_item` permission.

## Rate Limit
## Rate limit

{% multi_lang_include rate_limits.md endpoint='synchronous catalog item' %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-
| `items` | Required | Array | An array that contains item objects. The item objects should contain all of the fields in the catalog except for the `id` field. Only one item object is allowed per request. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4 role="presentation" }

## Example Request
## Example request

```
curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Authorization: Bearer YOUR-REST-API-KEY
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4 role="presentation" }

## Request example

```
curl --location --request POST 'https://rest.iad-01.braze.com/users/external_ids/remove' \
--header 'Content-Type: application/json' \
Expand All @@ -64,11 +65,13 @@ curl --location --request POST 'https://rest.iad-01.braze.com/users/external_ids
]
}'
```

{% alert important %}
Only deprecated IDs can be removed; attempting to remove a primary external ID will result in an error.
{% endalert %}

## Response
## Response

The response will confirm all successful removals, as well as unsuccessful removals with the associated errors. Error messages in the `removal_errors` field will reference the index in the array of the original request.

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,11 @@ Authorization: Bearer YOUR-REST-API-KEY
| `external_id_renames` | Required | Array of external identifier rename objects | View request example and the following limitations for the structure of the external identifier rename object. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4 role="presentation" }

- The `current_external_id` must be the user's primary ID, and cannot be a deprecated ID
- The `new_external_id` must not already be in use as either a primary ID or a deprecated ID
- The `current_external_id` and `new_external_id` cannot be the same
Note the following:

- The `current_external_id` must be the user's primary ID, and cannot be a deprecated ID.
- The `new_external_id` must not already be in use as either a primary ID or a deprecated ID.
- The `current_external_id` and `new_external_id` cannot be the same.

## Request example
```
Expand All @@ -75,7 +77,8 @@ curl --location --request POST 'https://rest.iad-01.braze.com/users/external_ids
}'
```

## Response
## Response

The response will confirm all successful renames, as well as unsuccessful renames with any associated errors. Error messages in the `rename_errors` field will reference the index of the object in the array of the original request.

```
Expand All @@ -87,26 +90,27 @@ The response will confirm all successful renames, as well as unsuccessful rename
```

The `message` field will return `success` for any valid request. More specific errors are captured in the `rename_errors` array. The `message` field returns an error in the case of:

- Invalid API key
- Empty `external_id_renames` array
- `external_id_renames` array with more than 50 objects
- Rate limit hit (more than 1,000 requests/minute)
- Rate limit hit (more than 1,000 requests per minute)

## Frequently asked questions

**Does this impact MAU?**<br>
### Does this impact MAU?
No, since the number of users will stay the same, they'll just have a new `external_id`.

**Does user behavior change historically?**<br>
### Does user behavior change historically?
No, since the user is still the same, and all their historical behavior is still connected to them.

**Can it be run on dev/staging workspaces?**<br>
### Can it be run on development or staging workspaces?
Yes. In fact, we highly recommend running a test migration on a staging or development workspace, and ensuring everything has gone smoothly before executing on production data.

**Does this consume data points?**<br>
### Does this consume data points?
This feature does not cost data points.

**What is the recommended deprecation period?**<br>
### What is the recommended deprecation period?
We have no hard limit on how long you can keep deprecated external IDs around, but we highly recommend removing them after there is no longer a need to reference users by the deprecated ID.

{% endapi %}
4 changes: 2 additions & 2 deletions _docs/_api/endpoints/user_data/post_user_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Authorization: Bearer YOUR_REST_API_KEY

```json
{
"external_ids" : (optional, array of string) External ids for the users to delete,
"external_ids" : (optional, array of string) External IDs for the users to delete,
"user_aliases" : (optional, array of user alias objects) User aliases for the users to delete,
"braze_ids" : (optional, array of string) Braze user identifiers for the users to delete,
"email_addresses": (optional, array of string) User emails for the users to delete
Expand Down Expand Up @@ -100,7 +100,7 @@ curl --location --request POST 'https://rest.iad-01.braze.com/users/delete' \
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"deleted" : (required, integer) number of user ids queued for deletion
"deleted" : (required, integer) number of user IDs queued for deletion
}
```
{% endapi %}
Expand Down