POST

/domains/{DomainName}/profiles/objects

http://profile.{region}.amazonaws.com/domains/{DomainName}/profiles/objects

Returns a list of objects associated with a profile of a given ProfileObjectType.

Access Token Required: API Key

Path Parameters

DomainNamestringrequired

The unique name of the domain.

Query Params

next-tokenstring

The pagination token from the previous call to ListProfileObjects.

max-resultsinteger

The maximum number of objects returned per page.

Body Params

ProfileIdstringrequired

The unique identifier of a customer profile.

ObjectFilterobject

The filter applied to ListProfileObjects response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

ObjectTypeNamestringrequired

The name of the profile object type.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://profile.{region}.amazonaws.com/domains/{DomainName}/profiles/objects' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}