External ID Rename

post

/users/external_ids/rename

Use this endpoint to “rename” your users’ external IDs. This endpoint sets a new (primary) external_id for the user and deprecates their existing external_id. This means that the user can be identified by either external_id until the deprecated one is removed. The deprecated ID can be removed using the remove endpoint. Having multiple external IDs allows for a migration period whereby older versions of your apps still in the wild that use the previous external ID naming schema don’t break. We highly recommend removing deprecated external IDs once your old naming schema is no longer in use.

You can send up to 50 rename objects per request.

You will need to create a new API key with permissions for this endpoint.

Request Body

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
1
2
3
4
5
6
7
8
9
10
{
  "external_id_renames" : (required, array of external ID Renames Object)
  [
    {
      "current_external_id" : (required, string) existing external ID for the user,
      "new_external_id" : (required, string) new external ID for the user, must be unique
    },
    ...
  ]
}

Request Example

1
2
3
4
5
6
7
8
9
10
11
12
curl --location --request POST 'https://rest.iad-01.braze.com/users/external_ids/rename' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "external_id_renames" : 
  [
    {
      "current_external_id": "your_existing_external_id",
      "new_external_id" : "your_new_external_id"
    }
  ]
}'

Response Body

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.

1
2
3
4
5
6
7
{

  "message" : (string) status message,
  "external_ids" : (array of successful Rename Operations),
  "rename_errors": (array of any <minor error message>)

}

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 (>1,000 requests/minute)

Frequently Asked Questions

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?

  • No, since the user is still the same user, and all their historical behavior is still connected to them.

Can it be run on dev/staging app groups?

  • Yes. In fact, we highly recommend running a test migration on a staging or development app group, and ensuring everything has gone smoothly before executing on production data.

Does this consume data points?

  • This feature does not cost data points.

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 once there is no longer a need to reference users by the deprecated ID.
WAS THIS PAGE HELPFUL?
New Stuff!