Set attributes on a profile

Set attributes on a profile

Updates profile attribute values using their version IDs as keys. Permits changes to default and custom attributes.

When any e-commerce integration is connected to the specified section then also e-commerce attributes can be modified.

In its requests and responses, APSIS One API accepts and returns version IDs and dates as strings. On the other hand, attribute value data types follow attribute types as described in this Help Center article.

Content must follow JSON Merge Patch specs. The maximum data payload size for requests to this endpoint is 100KB.

Profiles and attributes

Profiles are created on account level whereas attributes and tags are defined on sections. They are then set on profiles on section level as well.

Even though default attributes like First Name or Email have the same names across sections, setting their value on a profile in one section will not affect their values in other sections. Custom attributes and tags created in one section can only set on profiles on that section level.

Profile keys

Your profile may have a profile key in one of the following keyspaces. Keyspaces have corresponding attribute types. The values of the profile keys and the attributes should ideally match.

  • Email: keyspace and attribute
  • SMS: keyspace and attribute
  • CRM-ID: keyspace com.apsis1.keyspaces.crm-id and attribute com.apsis1.attributes.crmid

When you update the value of, say, Email attribute using this endpoint, it will not update the corresponding profile key. You will still only be able to locate the profile (in the UI or the API) using the old email but it will be shown in APSIS One with the updated Email attribute value.

This behavior is improved in Set attributes on a profile (version 2).

Consent addresses

The APSIS One platform enables your profiles to provide consent to receive communication from you. Consent is created using a selected communication channel: email, SMS or both. Each of these channels has a corresponding profile attribute: email and mobile, respectively. So when a profile consents to receive information from you over the email channel, the platform will use their primary email address attribute when sending emails.

As long as your account uses Consent 1.0, a consent is bound to the address. This changes in Consent 2.0, where consent is created on the profile level. More on that in this article.

If you need to change an email address or phone number for your profile, we recommend using Set attributes on a profile (version 2). This new version automatically moves consent from the original address to the new one while your account uses Consent 1.0 and will work correctly when your account gets migrated to Consent 2.0.

The best time to adopt Set attributes on a profile (version 2) is when switching to Consent 2.0 endpoints in APSIS One API following this guide.

Deleting attributes

This endpoint supports removing attribute values from a profile. To do this, provide null as attribute value in the request body.