Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchPutProfileObject

Adds multiple profile objects to a domain of a given ObjectType in a single API call.

When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.

When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

BatchPutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

Request Syntax


PUT /domains/DomainName/profiles/objects/batch-put-profile-object HTTP/1.1
Content-type: application/json

{
   "Items": [ 
      { 
         "Id": "string",
         "Object": "string"
      }
   ],
   "ObjectTypeName": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Items

A list of items to add to the domain.

Type: Array of BatchPutProfileObjectRequestItem objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

ObjectTypeName

The name of the profile object type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Failed": [ 
      { 
         "Code": number,
         "Id": "string",
         "Message": "string"
      }
   ],
   "Successful": [ 
      { 
         "Id": "string",
         "ProfileObjectUniqueKey": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Failed

A list of items that failed to be added to the domain.

Type: Array of BatchPutProfileObjectErrorItem objects

Successful

A list of items that were successfully added to the domain.

Type: Array of BatchPutProfileObjectResponseItem objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429