Extole Profiles API
The Profiles API from Extole — 41 operation(s) for profiles.
Extole Profiles API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Profiles. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 50 operations across 41 paths, and defines 70 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://{brand}.extole.io.
50 operations
41 paths
70 schemas
1 DELETE33 GET14 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Extole Profiles API declares
3 security schemes
for authenticating requests.
An API key is passed in the cookie as extole_token (COOKIE).
An API key is passed in the header as Authorization (HEADER).
An API key is passed in the query as access_token (QUERY).
By default, every request must be authenticated.
Paths & Operations 50
Across 41 paths, the API surfaces 50 operations — 1 DELETE, 33 GET, 14 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Profiles 50
GET
/api/v4/events/share/status/{pollingId}deprecated
Get share event status
GET
/api/v4/me
Get the authenticated consumer profile
POST
/api/v4/me
Update the authenticated consumer profile
GET
/api/v4/me/advocatesdeprecated
List advocate relationships
GET
/api/v4/me/assets
List assets for the authenticated consumer
POST
/api/v4/me/assets
Create an asset for the authenticated consumer
GET
/api/v4/me/assets/download
Download an asset by name
GET
/api/v4/me/assets/{assetId}
Get an asset by ID
DELETE
/api/v4/me/assets/{assetId}
Delete an asset by ID
GET
/api/v4/me/assets/{assetId}/download
Download an asset by ID
GET
/api/v4/me/audience-memberships
List audience memberships
GET
/api/v4/me/friendsdeprecated
List friends for the authenticated consumer
GET
/api/v4/me/journeys
List journeys for the authenticated consumer
GET
/api/v4/me/parameters
Get profile parameters for the authenticated consumer
POST
/api/v4/me/parameters
Update multiple profile parameters
GET
/api/v4/me/referrals-from-me
List referrals from the authenticated consumer
GET
/api/v4/me/referrals-to-me
List referrals to the authenticated consumer
GET
/api/v4/me/rewards/status
Get reward redemption status
GET
/api/v4/me/send-verification-email/status/{pollingId}deprecated
Get verification email status
GET
/api/v4/me/shareablesdeprecated
List shareables for the authenticated consumer (legacy)
POST
/api/v4/me/shareablesdeprecated
Create a shareable (legacy)
GET
/api/v4/me/shareables/status/{polling_id}deprecated
Get shareable creation status (legacy)
GET
/api/v4/me/shareables/{shareable_id}deprecated
Get a shareable by ID (legacy)
PUT
/api/v4/me/shareables/{shareable_id}deprecated
Update a shareable (legacy)
GET
/api/v4/me/shares
List shares for the authenticated consumer
GET
/api/v4/me/shares/{shareId}
Get a share by ID
GET
/api/v4/me/steps
List steps for the authenticated consumer
GET
/api/v4/shareabledeprecated
Look up shareables by code (legacy)
POST
/api/v4/shareabledeprecated
Create a shareable (legacy)
GET
/api/v4/shareable/status/{polling_id}deprecated
Get shareable creation status (legacy)
GET
/api/v4/shareable/{shareable_id}deprecated
Get a shareable by ID (legacy)
GET
/api/v4/sharesdeprecated
List shares
GET
/api/v4/shares/{share_id}deprecated
Get a share by ID
GET
/api/v5/custom/share/status/{pollingId}deprecated
Get custom share status
GET
/api/v6/me/shareables
List shareables for the authenticated consumer
POST
/api/v6/me/shareables
Create a shareable for the authenticated consumer
GET
/api/v6/me/shareables/{code}
Get a shareable by code
POST
/api/v4/events/sharedeprecated
Submit a share event
POST
/api/v4/me/send-verification-emaildeprecated
Send a profile verification email
POST
/api/v5/custom/sharedeprecated
Submit a custom share event
POST
/api/v5/email/share/batchdeprecated
Send referral email shares in batch (legacy)
POST
/api/v6/me/shareables/get-create-or-update
Get, create, or update a shareable
POST
/api/v6/me/shareables/get-or-create
Get or create a shareable
PUT
/api/v4/me/parameters/{parameter_name}
Set a single profile parameter
GET
/v4/me/public-steps
List public steps for the authenticated consumer
GET
/v4/me/shares-all
List all shares for the authenticated consumer
GET
/v4/optout/{secure_email}
POST
/v4/optout/{secure_email}
POST
/v6/address/validate
Validate a postal address
GET
/v3/shareables/{code}
Get a shareable link
Schemas 70
The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are JourneyResponse (29 properties), RewardResponse (22 properties), FormDataBodyPart (14 properties), ShareResponse (14 properties). Each schema is shown below with its type and property counts.
ContentDisposition
object
7 properties
PublicShareResponse
object
8 properties
8 required
UpdateProfileResponse
object
2 properties
2 required
FormDataContentDisposition
object
8 properties
JourneyResponse
object
29 properties
29 required
VerificationEmailResponse
object
2 properties
2 required
BatchEmailShareV5Request
object
5 properties
5 required
CustomShareResponse
object
2 properties
2 required
ShareableContent
object
5 properties
QualityResults
object
2 properties
PublicPersonStepResponse
object
6 properties
6 required
AddressValidationRequest
object
2 properties
2 required
RelationshipResponse
object
5 properties
5 required
EventShareResponse
object
2 properties
2 required
MessageBodyWorkers
object
AddressValidationResponse
object
2 properties
2 required
CreateMeShareableV4Request
object
6 properties
6 required
QualityRuleResult
object
2 properties
Verdict
object
4 properties
StepResponse
object
1 property
MyProfileResponse
object
12 properties
12 required
CustomShareRequest
object
5 properties
5 required
EditMeShareableV4Request
object
5 properties
5 required
CreateMeShareableRequest
object
5 properties
5 required
ShareResponse
object
14 properties
14 required
Providers
object
PersonShareableV4Response
object
7 properties
7 required
CreateShareableV4Request
object
6 properties
5 required
MeShareableV4Response
object
7 properties
7 required
CustomSharePollingResponse
object
4 properties
4 required
EmailShareV5Response
object
2 properties
2 required
SuccessResponse
object
1 property
1 required
ShareableCreateV4Error
object
5 properties
BodyPart
object
8 properties
EventSharePollingResponse
object
4 properties
4 required
Address
object
5 properties
EventShareRequest
object
6 properties
6 required
PersonProfileUpdateRequest
object
Body of a POST /v4/me request.
6 properties
6 required
JourneyKey
object
2 properties
ParameterizedHeader
object
2 properties
ShareableCreateV4PollingResponse
object
4 properties
4 required
RewardResponse
object
22 properties
22 required
FriendEvent
object
4 properties
CreateShareableV4Response
object
5 properties
5 required
PartnerEventIdResponse
object
2 properties
ConsumerEventRequest
object
11 properties
1 required
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties
5 required
MultiPart
object
9 properties
AssetResponse
object
7 properties
7 required
MeDataUpdateRequest
object
Body of a PUT /v4/me/parameters/{parametername} request.
2 properties
2 required
AudienceMembershipResponse
object
3 properties
3 required
PollingRewardResponse
object
3 properties
3 required
CreateMeShareableV4Response
object
1 property
1 required
AssetRequest
object
3 properties
3 required
VerificationEmailRequest
object
1 property
1 required
PostalAddress
object
3 properties
MediaType
object
5 properties
AddressComponent
object
6 properties
ComponentName
object
2 properties
MeShareableResponse
object
6 properties
6 required
GetShareableV4Response
object
8 properties
8 required
PersonShareableContentV4Response
object
5 properties
MeDataBulkUpdateRequest
object
Body of a POST /v4/me/parameters request.
2 properties
2 required
OptoutResponse
object
2 properties
2 required
OptoutRequest
object
5 properties
5 required
PublicPersonResponse
object
4 properties
4 required
ShareableV4Content
object
5 properties
FormDataBodyPart
object
14 properties
FriendProfileResponse
object
4 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Extole 12
Other APIs Extole publishes across the network.
Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API
#Profiles