Profile Management — API Reference

Manage Profiles, their attributes, agreements, and consents

87 endpoints across 6 tags.

Profile registration

• POST /sauth/clients/registered — Register a Profile
• POST /sauth/clients/activation/by-pin-code/confirmation — Confirm registration with PIN code
• POST /sauth/clients/activation/by-pin-code/request — Re-send PIN code
• POST /sauth/clients/activation/confirmation — Activate a Profile's account
• POST /sauth/clients/activation/request — Re-send email confirmation

Profile management

• POST /v4/clients — Create a Profile
• POST /v4/clients/merge/from/custom-ids/{sourceCustomIDs}/to/custom-id/{targetCustomID} — Merge profiles by customId
• POST /v4/clients/merge/from/ids/{fromClientIds}/to/id/{toClientId} — Merge profiles by clientId
• POST /v4/clients/batch — Batch add or update profiles
• GET /v4/clients/{clientId} — Get profile data
• POST /v4/clients/{clientId} — Update a profile (identify by ID)
• DELETE /v4/clients/{clientId} — Delete a profile
• POST /v4/clients/by-email/{clientEmail} — Update a profile (identify by email)
• POST /v4/clients/by-customid/{customId} — Update a profile (identify by customId)
• DELETE /v4/clients/by-custom-id/{customId} — Delete a profile (identify by customId)
• GET /v4/clients/{identifierType}/{identifierValue} — Fetch profile data
• GET /v4/clients/batch/by-phone/{phoneNumber} — Batch fetch profiles by phone number
• GET /crm/v1/clients/{clientId}/contacts — Get Profile details
• PUT /crm/v1/contacts/{clientId} — Update Profile
• POST /morph/exports/clients/segmentation — Create and run profile export
• GET /morph/exports/clients/{taskId}/status — Check profile export status
• GET /morph/exports/clients/{taskId}/data — Get exported profiles
• GET /notes-service/by-id/{clientId} — Get all Profile notes
• POST /notes-service/by-id/{clientId} — Create a note
• GET /notes-service/by-id/{clientId}/{noteId} — Get note
• PUT /notes-service/by-id/{clientId}/{noteId} — Update note
• DELETE /notes-service/by-id/{clientId}/{noteId} — Delete note
• POST /sauth/management/client/{clientID}/logout — Log out a Profile

Profile account management

• GET /v4/my-account/personal-information — Get Profile's own data
• POST /v4/my-account/personal-information — Update Profile's own data
• POST /v4/my-account/phone-update/request — Request profile phone number change
• POST /v4/my-account/phone-update/confirmation — Confirm profile phone number change
• POST /sauth/clients/password-reset/request — Request Profile password reset
• POST /sauth/clients/password-reset/confirmation — Confirm Profile password reset
• POST /sauth/my-account/change-password — Change Profile password
• POST /sauth/v2/my-account/delete — Delete account
• POST /sauth/v2/my-account/email-change/request — Request Profile email change
• POST /sauth/v3/my-account/logout — Log out a Profile
• POST /sauth/my-account/email-change/confirmation — Confirm Profile email change
• POST /sauth/clients/facebook/email-change/request — Change Facebook Profile email
• POST /sauth/clients/oauth/deleted — Delete Client Account (OAuth) (deprecated)
• POST /sauth/clients/apple/deleted — Delete Profile account (Sign in with Apple) (deprecated)
• POST /sauth/clients/facebook/deleted — Delete Facebook Profile Account (deprecated)
• POST /sauth/my-account/delete — Delete account (deprecated)
• POST /sauth/my-account/email-change/request — Request Profile email change (deprecated)

Profile devices

• POST /v4/clients/{clientId}/linked-devices — Link a device by profile ID
• POST /v4/clients/{identifierType}/{identifierValue}/linked-devices — Link a device by other parameters
• POST /v4/my-account/linked-devices — Link a device to currently logged in profile
• POST /push-devices/web-push/clean-up/{clientId} — Clean up web push tokens
• POST /push-devices/mobile-push-subscriber/clean-up/{clientId} — Clean up mobile push tokens

Tags

• GET /v4/clients/tags — Get all tags
• POST /v4/tags — Create a tag
• PUT /v4/tags/{tagID} — Update a tag
• DELETE /v4/tags/{tagID} — Remove a tag
• GET /v4/clients/{clientId}/tags — Get profile tags
• POST /v4/clients/{clientId}/tags/{tagID} — Assign tag to profile
• DELETE /v4/clients/{clientId}/tags/{tagID} — Remove tag from profile

Events

• POST /v4/transactions — Create a transaction
• POST /v4/transactions/batch — Batch add or update transactions
• GET /v4/events/by-client/{clientId} — Get Profile events as Workspace (deprecated)
• GET /v4/events — Get Profile's own events (deprecated)
• POST /v4/events/application-started — Application started
• POST /v4/events/registered — Profile account registered
• POST /v4/events/logged-in — Profile logged in
• POST /v4/events/logged-out — Profile logged out
• POST /v4/events/added-to-cart — Item added to cart
• POST /v4/events/removed-from-cart — Item removed from cart
• POST /v4/events/added-to-favorites — Product added to favorites
• POST /v4/events/product-view — Item viewed
• POST /v4/events/assigned-to-company — Profile assigned to company
• POST /v4/events/appeared-in-location — Profile logged location
• POST /v4/events/push/received — Push notification received
• POST /v4/events/push/viewed — Push notification viewed
• POST /v4/events/push/clicked — Push notification clicked
• POST /v4/events/push/cancelled — Push notifications cancelled
• POST /v4/events/cancelled-transaction — Transaction cancelled
• POST /v4/events/hit-timer — Timer hit
• POST /v4/events/searched — Search requested
• POST /v4/events/shared — Content shared
• POST /v4/events/recommendation-seen — Recommendation viewed (deprecated)
• POST /v4/events/recommendation-click — Recommendation clicked (deprecated)
• POST /v4/events/visited-screen — Mobile app screen visited
• POST /v4/events/custom — Custom event
• POST /v4/events/batch — Batch send events
• GET /v4/server/time — Get server time
• POST /v4/events/recommendation-view — Recommendation viewed
• POST /v4/events/item-search-click — Search result clicked

Back to all API categories