Update profile (POST)
Header Parameters
Authorization token
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
System generated unique identifier of the profile.
Body Parameters
A collection of consents associated with the User Profile.
Show child attributes
A collection of Custom Fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
Collection of addresses associated with the profile.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
A collection of preferences associated with the User Profile. Profile preferences are tied to the user’s profile. These preferences are not associated with any contact element on the profile.
Show child attributes
Read-Only Id associated with the Profile.
Defines whether the item is Active or Inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person by the type of customer. For example: Retail, Commercial, or Marketing.
Specifies whether to retain the contact element consents or deactivate them. To retain the contact element consents, set the value as True. If set to False, the contact element consents will be deactivated. This setting defaults to True, if not specified.
Specifies whether to retain the preferences or deactivate them. To retain the preferences, set the value as True. If set to False, the preferences will be deactivated. This setting defaults to True, if not specified.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Read-Only field. 'Complete' if the record has been processed otherwise 'Pending Update'.
An optional parameter that can be passed when deactivating a profile.
Collection of AlternateIds associated with the profile.
Show child attributes
Response
Once the request is received, it is queued for processing and a 202 response is returned with the UpdateStatus of "Pending Update". When processing is completed, the profile is updated. Any subsequent GET operations to retrieve the profile will include a value for the UpdateStatus of either "Complete" or "Pending Update".
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.
The request could not be completed due to a conflict with the current state of the target resource. In most cases, an instance with the same already exists on the target resource. You must update the request before trying again.
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.