SPspade
Category Personalization

Create a user-level counterparty category personalization

Create a user-level counterparty category personalization.

This personalization will apply to all enrichments that take place at the given counterpartyId for the user with the given userId.

To learn more about user category personalization, please read the User Category Personalization Guide.

put/users/{userId}/counterparty-category-personalizations

Request

  • Base URL
    https://east.sandbox.spade.com
  • URL
    https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations
  • Auth
    API key in header X-Api-Key

Request body

counterpartyIdstring required

The ID of the counterparty.

categoryIdstring required

The ID of the category. Can be a Spade category ID (e.g. "011-000-000-000") or a custom category ID (e.g. "e4cf5379-583f-44ed-b625-366044e666e6").

Example request

{
  "counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
  "categoryId": "011-000-000-000"
}

Response

Updated

counterpartyIdstring required

The ID of the counterparty.

categoryIdstring required

The ID of the category. Can be a Spade category ID (e.g. "011-000-000-000") or a custom category ID (e.g. "e4cf5379-583f-44ed-b625-366044e666e6").

userIdstring

The ID of the newly created counterparty category personalization.

Example response

{
  "counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
  "categoryId": "011-000-000-000",
  "userId": "user1234"
}

Changes

No recorded changes to this operation across all 1 revision of this API.