Skip to main content
POST
/
resource-alias
Create a new resource alias.
curl --request POST \
  --url https://vanguard.profilebehavior.com/api/v4/resource-alias \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resourceType": "profile",
  "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.

Body

application/json

The properties to be assigned to the resource alias.

​
resourceType
enum<string>
required

The resource type that the alias is for. This corresponds to existing model types in the Profile system.

Available options:
profile
​
resourceId
string
required

A valid bson Object ID which corresponds to an existing data object in the Profile system based on the the resourceType indicated.

​
consumerKey
string
required

The custom identifier that can be used as an alias for the resource specified. This could be a text description, an ID from an external system, etc.

Response

Success — Existing Alias Found

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.