v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1438230222.0 KB

Defines a ProfileObjectType.

To add or remove tags on an existing ObjectType, see TagResource/UntagResource.

put/domains/{DomainName}/object-types/{ObjectTypeName}

Path parameters

DomainNamestring required

The unique name of the domain.

ObjectTypeNamestring required

The name of the profile object type.

Request body

Descriptionstring required

Description of the profile object type.

TemplateIdstring

A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a <code>BadRequestException</code>. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a <code>BadRequestException</code>.

ExpirationDaysinteger

The number of days until the data in the object expires.

EncryptionKeystring

The customer-provided key to encrypt the profile object that will be created in this profile object type.

AllowProfileCreationboolean

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to <code>TRUE</code>, and if no match is found, then the service creates a new standard profile.

SourceLastUpdatedTimestampFormatstring

The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up.

Fieldsobject

A map of the name and ObjectType field.

Keysobject

A list of unique keys that can be used to map data to the profile.

Tagsobject

The tags used to organize, track, or control access for this resource.

Response

Success

ObjectTypeNamestring required

The name of the profile object type.

Descriptionstring required

Description of the profile object type.

TemplateIdstring

A unique identifier for the object template.

ExpirationDaysinteger

The number of days until the data in the object expires.

EncryptionKeystring

The customer-provided key to encrypt the profile object that will be created in this profile object type.

AllowProfileCreationboolean

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is <code>FALSE</code>. If the AllowProfileCreation flag is set to <code>FALSE</code>, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to <code>TRUE</code>, and if no match is found, then the service creates a new standard profile.

SourceLastUpdatedTimestampFormatstring

The format of your <code>sourceLastUpdatedTimestamp</code> that was previously set up in fields that were parsed using <a href="https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a>. If you have <code>sourceLastUpdatedTimestamp</code> in your field, you must set up <code>sourceLastUpdatedTimestampFormat</code>.

Fieldsobject

A map of the name and ObjectType field.

Keysobject

A list of unique keys that can be used to map data to the profile.

CreatedAtstring date-time

The timestamp of when the domain was created.

LastUpdatedAtstring date-time

The timestamp of when the domain was most recently edited.

Tagsobject

The tags used to organize, track, or control access for this resource.