API reference
Profiles API
People: their identifiers, properties, location and consent to email and SMS.
Endpoints
- GETList profile import jobs/api/profile-bulk-import-jobs
- POSTImport profiles in bulk/api/profile-bulk-import-jobs
- POSTCreate or update a profile/api/profile-import
- POSTMerge profiles/api/profile-merge
- POSTSubscribe profiles/api/profile-subscription-bulk-create-jobs
- POSTUnsubscribe profiles/api/profile-subscription-bulk-delete-jobs
- GETList suppression jobs/api/profile-suppression-bulk-create-jobs
- POSTSuppress profiles/api/profile-suppression-bulk-create-jobs
- GETList unsuppression jobs/api/profile-suppression-bulk-delete-jobs
- POSTUnsuppress profiles/api/profile-suppression-bulk-delete-jobs
- GETList profiles/api/profiles
- POSTCreate a profile/api/profiles
- GETList push tokens/api/push-tokens
- POSTRegister a push token/api/push-tokens
- GETGet a profile import job/api/profile-bulk-import-jobs/{job_id}
- GETGet a suppression job/api/profile-suppression-bulk-create-jobs/{job_id}
- GETGet an unsuppression job/api/profile-suppression-bulk-delete-jobs/{job_id}
- GETGet a profile/api/profiles/{id}
- PATCHUpdate a profile/api/profiles/{id}
- GETGet a push token/api/push-tokens/{id}
- DELDelete a push token/api/push-tokens/{id}
- GETGet the errors of a profile import job/api/profile-bulk-import-jobs/{id}/import-errors
- GETGet the lists of a profile import job/api/profile-bulk-import-jobs/{id}/lists
- GETGet the profiles of a profile import job/api/profile-bulk-import-jobs/{id}/profiles
- GETGet the conversation of a profile/api/profiles/{id}/conversation
- GETGet the conversations of a profile/api/profiles/{id}/conversations
- GETGet the lists of a profile/api/profiles/{id}/lists
- GETGet the push tokens of a profile/api/profiles/{id}/push-tokens
- GETGet the segments of a profile/api/profiles/{id}/segments
- GETGet the profile of a push token/api/push-tokens/{id}/profile
- GETGet the list ids of a profile import job/api/profile-bulk-import-jobs/{id}/relationships/lists
- GETGet the profile ids of a profile import job/api/profile-bulk-import-jobs/{id}/relationships/profiles
- GETGet the conversation id of a profile/api/profiles/{id}/relationships/conversation
- GETGet the conversation ids of a profile/api/profiles/{id}/relationships/conversations
- GETGet the list ids of a profile/api/profiles/{id}/relationships/lists
- GETGet the push token ids of a profile/api/profiles/{id}/relationships/push-tokens
- GETGet the segment ids of a profile/api/profiles/{id}/relationships/segments
- GETGet the profile id of a push token/api/push-tokens/{id}/relationships/profile
Access
A private key with these scopes reaches every endpoint here. Each endpoint page lists the scopes it needs.
conversations:readlists:readlists:writeprofiles:readprofiles:writepush-tokens:readpush-tokens:writesegments:readsubscriptions:readsubscriptions:writeCoverage
38 of the 38 operations in this area of Klaviyo's API are built here.
Complete
Every operation in this area of Klaviyo's API is built.