Skip to main content
PATCH
/
resource-alias
/
{resourceAliasId}
Update a resource alias.
curl --request PATCH \
  --url https://vanguard.profilebehavior.com/api/v4/resource-alias/{resourceAliasId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceId": "<string>",
  "consumerKey": "<string>"
}
'
{
  "code": 200,
  "resourceAlias": {
    "resourceType": "profile",
    "resourceId": "6592008029c8c3e4dc76256c",
    "consumerKey": "group_1"
  },
  "status": "success"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

resourceAliasId
string
required

The ID of the resource alias to update.

Body

application/json

The properties to be updated for the resource alias.

resourceId
string

The ID of a data resource stored in the Profile system. The type of data is dependent on the resource type defined.

consumerKey
string

The custom defined identifier. This can be a text label, external ID, etc.

Response

Success

Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.

code
integer<int32>
required

HTTP status code of the successful response.

status
enum<string>

Always "success" for successful responses.

Available options:
success
resourceAlias
object

Base schema that provides unique identification and timestamp metadata for resources in the Profile Behavior API.

Represents a resource alias for a data document in the Profile system.