PrincipalAttributeService

ArchivePrincipalAttributeEnumValue

Archives a principal attribute enum value and migrates all principal attribute values with that enum value to a replacement enum value.

post/api/v1/principal-attribute-enum-values/{archivedEnumValueId}/archive

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/principal-attribute-enum-values/{archivedEnumValueId}/archive
  • Auth: HTTP bearer

Path parameters

archivedEnumValueIdstring required

Request body

replacementEnumValueIdstring

When the archived_enum_value_id is archived all principal attribute values that reference it will be migrated to the replacement_enum_value_id if provided. Otherwise, user-attributes that reference it will be archived as well.

Response

A successful response.

principalAttributeValuesMigratedinteger

Total number of principal attribute values migrated or archived by this operation. When a replacement enum value is provided, this represents values migrated to the new value. When no replacement is provided, this represents values that were archived.

Changes

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