# Extole Documentation: API Reference > Guides, product documentation, and API reference for the Extole platform. ## API Reference - [API Reference / Management API (289 pages)](https://docs.extole.com/_llms/api-reference/management-api.md): Documentation for API Reference / Management API. ### Getting Started - [API Overview](https://docs.extole.com/api-reference/getting-started/api-overview.md): Start with the right Extole API, authenticate your request, and make your first call. - [Authentication](https://docs.extole.com/api-reference/getting-started/authentication-overview.md): Every call to the Extole API carries an access token. The API uses two token models, chosen by where the caller runs. - [Errors](https://docs.extole.com/api-reference/getting-started/common-errors.md): Understand common errors returned by Extole's APIs. ### Consumer to Extole API #### Authentication - [Get consumer token details](https://docs.extole.com/api-reference/authentication/get-consumer-token-details.md): Returns the metadata for the access token supplied in the `access_token` query parameter or bearer header. If no token is supplied, the server attempts to resolve a token from the HTTP authorization header. Returns the token's expiry, scopes, and the identity it represents. - [Create a consumer access token](https://docs.extole.com/api-reference/authentication/create-a-consumer-access-token.md): Issues a new access token for the identity supplied in the request. Pass an `email` to identify a consumer when the client identity key is `email`. Pass a `jwt` to assert a trusted identity via JWT verification. Omit both to issue an anonymous token. The optional `duration_seconds` field caps the to… - [Delete a consumer access token](https://docs.extole.com/api-reference/authentication/delete-a-consumer-access-token.md): Revokes the access token supplied in the `access_token` query parameter or bearer header. If no token is supplied, the server attempts to resolve a token from the HTTP authorization header and revokes that one. After revocation the token is immediately invalidated. #### Content - [Render a zone](https://docs.extole.com/api-reference/content/render-a-zone.md): API-friendly zone rendering at `POST /api/v6/zones`. Intended for backend rendering where the caller supplies a bearer access token directly. Renders the zone identified by `event_name` in the JSON request body and returns the structured zone content as JSON. Returns an error when no content backs t… - [Render a named zone](https://docs.extole.com/api-reference/content/render-a-named-zone.md): API-friendly zone rendering at `POST /api/v6/zones/{event_name}`. Intended for backend rendering where the caller supplies a bearer access token directly. Renders the zone identified by the `event_name` path parameter and returns the structured zone content as JSON. Pass zone input data in the reque… - [Render a zone with the name in the body](https://docs.extole.com/api-reference/content/render-a-zone-with-the-name-in-the-body.md): Web-friendly zone rendering at `POST /zones`. Intended for direct use from a browser page or web SDK embed — accepts form-encoded, plain-text, and multipart bodies in addition to JSON, and handles cookie-based identity automatically. Renders the zone identified by `event_name` in the request body, a… - [Render a named zone for web-page embedding](https://docs.extole.com/api-reference/content/render-a-named-zone-for-web-page-embedding.md): Web-friendly zone rendering at `POST /zones/{zone_name}`. Intended for direct use from a browser page or web SDK embed — accepts form-encoded and multipart bodies in addition to JSON, and handles cookie-based identity automatically. Renders the zone identified by `zone_name` and returns its content… #### Events - [Submit a consumer event by URL](https://docs.extole.com/api-reference/events/submit-a-consumer-event-by-url.md): Fires the named consumer event using data from the query string and optional JWT claim. Always returns HTTP 200 regardless of outcome — check for an `X-Extole-Error-Message` response header to detect processing errors. A new `access_token` cookie may be set on the response when the event establishes… #### Profile Assets - [List assets for a person](https://docs.extole.com/api-reference/profiles/list-assets-for-a-person.md): Returns all assets attached to the person profile identified by `personId`. Assets are binary or text files associated with a program participant — for example, wallet passes, QR codes, or uploaded images. Use `getPersonAsset` to fetch a single asset's metadata, or `downloadPersonAsset` to retrieve… - [Download a person asset by name](https://docs.extole.com/api-reference/profiles/download-a-person-asset-by-name.md): Streams the binary or text content of the asset matching the `name` query parameter for the person identified by `personId`. Returns HTTP 302 if the content is hosted at a remote URL; returns HTTP 200 with the raw content otherwise. Use the id variant (`downloadPersonAsset`) when you have the asset… - [Get a person asset by ID](https://docs.extole.com/api-reference/profiles/get-a-person-asset-by-id.md): Returns full metadata for the asset identified by `assetId` and owned by the person identified by `personId`. Metadata includes the asset type, name, content URL, MIME type, and creation timestamp. Use `downloadPersonAsset` to stream the asset content. - [Download a person asset by asset ID](https://docs.extole.com/api-reference/profiles/download-a-person-asset-by-asset-id.md): Streams the binary or text content of the asset identified by `assetId`. Returns HTTP 302 if the content is hosted at a remote URL; returns HTTP 200 with the raw content otherwise. Use the `name` variant (`downloadPersonAssetByName`) when you have the asset name but not the id. The access token is o… #### Profiles - [Get the authenticated consumer profile](https://docs.extole.com/api-reference/profiles/get-the-authenticated-consumer-profile.md): Returns the profile of the consumer identified by the supplied access token. The response includes the consumer's identity attributes (email, partner user id, name), custom data fields stored in `parameters`, and consent state. - [Update the authenticated consumer profile](https://docs.extole.com/api-reference/profiles/update-the-authenticated-consumer-profile.md): Updates identity attributes and consent fields on the profile of the consumer identified by the access token. - [List assets for the authenticated consumer](https://docs.extole.com/api-reference/profiles/list-assets-for-the-authenticated-consumer.md): Returns all assets attached to the profile of the consumer identified by the access token. Assets are binary or text files such as wallet passes, QR codes, or uploaded images. - [Create an asset for the authenticated consumer](https://docs.extole.com/api-reference/profiles/create-an-asset-for-the-authenticated-consumer.md): Uploads a new asset and attaches it to the authenticated consumer's profile. Supply asset metadata in the `asset` form field and the file content in the `file` form field. - [Download an asset by name](https://docs.extole.com/api-reference/profiles/download-an-asset-by-name.md): Streams the binary or text content of the asset matching the `name` query parameter on the authenticated consumer's profile. Returns HTTP 302 if the content is hosted at a remote URL; returns HTTP 200 with the raw content otherwise. - [Get an asset by ID](https://docs.extole.com/api-reference/profiles/get-an-asset-by-id.md): Returns metadata for the asset identified by `assetId` on the authenticated consumer's profile. Use the download endpoints to retrieve the asset content. - [Delete an asset by ID](https://docs.extole.com/api-reference/profiles/delete-an-asset-by-id.md): Removes the asset identified by `assetId` from the authenticated consumer's profile and returns the deleted asset metadata. - [Download an asset by ID](https://docs.extole.com/api-reference/profiles/download-an-asset-by-id.md): Streams the binary or text content of the asset identified by `assetId`. Returns HTTP 302 if the content is hosted at a remote URL; returns HTTP 200 with the raw content otherwise. - [List audience memberships](https://docs.extole.com/api-reference/profiles/list-audience-memberships.md): Returns audience memberships for the authenticated consumer, including eligibility audiences that affect program participation. - [List journeys for the authenticated consumer](https://docs.extole.com/api-reference/profiles/list-journeys-for-the-authenticated-consumer.md): Returns journey records for the consumer identified by the access token. Filter by `container` or `type` (journey name) to narrow the result set. - [Get profile parameters for the authenticated consumer](https://docs.extole.com/api-reference/profiles/get-profile-parameters-for-the-authenticated-consumer.md): Returns all custom data fields stored in `parameters` on the profile of the consumer identified by the access token. - [Update multiple profile parameters](https://docs.extole.com/api-reference/profiles/update-multiple-profile-parameters.md): Creates or updates multiple custom data fields on the authenticated consumer's profile in a single request. Omitted fields are left unchanged. - [List referrals from the authenticated consumer](https://docs.extole.com/api-reference/profiles/list-referrals-from-the-authenticated-consumer.md): Returns referral relationships where the authenticated consumer is the advocate who referred others. - [List referrals to the authenticated consumer](https://docs.extole.com/api-reference/profiles/list-referrals-to-the-authenticated-consumer.md): Returns referral relationships where the authenticated consumer is the referred friend. - [Get reward redemption status](https://docs.extole.com/api-reference/profiles/get-reward-redemption-status.md): Returns the current state of a pending or completed reward redemption for the authenticated consumer. Supply exactly one of `polling_id` (returned by a prior reward claim call), `reward_name` (the configured reward name), or `partner_event_id` (the originating partner event identifier). Poll this en… - [List shares for the authenticated consumer](https://docs.extole.com/api-reference/profiles/list-shares-for-the-authenticated-consumer.md): Returns shares recorded for the authenticated consumer. Filter by `partner_share_id` or `partner_id` to narrow the result set. - [Get a share by ID for the current consumer](https://docs.extole.com/api-reference/profiles/get-a-share-by-id-for-the-current-consumer.md): Returns the share identified by `shareId` when it belongs to the authenticated consumer. - [List steps for the authenticated consumer](https://docs.extole.com/api-reference/profiles/list-steps-for-the-authenticated-consumer.md): Returns program steps completed by the authenticated consumer. Filter by `campaign_id`, `program_label`, `step_name`, or `quality` to narrow the result set. - [List shareables for the authenticated consumer](https://docs.extole.com/api-reference/profiles/list-shareables-for-the-authenticated-consumer.md): Returns shareables owned by the consumer identified by the access token. Filter by `key` or `label` to narrow the result set. - [Create a shareable for the authenticated consumer](https://docs.extole.com/api-reference/profiles/create-a-shareable-for-the-authenticated-consumer.md): Creates a new shareable link for the authenticated consumer. Returns the shareable with its assigned code and share URL. - [Get a shareable by code](https://docs.extole.com/api-reference/profiles/get-a-shareable-by-code.md): Returns the shareable identified by `code` when it belongs to the authenticated consumer. - [Get, create, or update a shareable](https://docs.extole.com/api-reference/profiles/get-create-or-update-a-shareable.md): Returns an existing shareable, creates one if missing, or updates it when the request data differs. Combines get-or-create with in-place updates. - [Get or create a shareable](https://docs.extole.com/api-reference/profiles/get-or-create-a-shareable.md): Returns an existing shareable matching the request criteria or creates one if none exists. Idempotent helper for mobile and headless integrations. - [Set a single profile parameter](https://docs.extole.com/api-reference/profiles/set-a-single-profile-parameter.md): Creates or updates one named custom data field on the authenticated consumer's profile. The parameter name is supplied in the `parameter_name` path segment. ### Server to Extole API #### Authentication - [Get current access token](https://docs.extole.com/api-reference/authentication/get-current-access-token.md): Returns the metadata for the access token used to authenticate the request (`type`, `client_id`, `identity_id`, `expires_in`, `scopes`). Equivalent to `GET /v4/tokens/{token}` but without having to repeat the token in the URL path. - [Create access token](https://docs.extole.com/api-reference/authentication/create-access-token.md): Mints a bearer token for server-to-Extole calls by a client. The body is optional: when omitted, the new token mirrors the calling identity's scopes; when supplied, the body can narrow the scope set (subset of the caller's scopes), bind the token to a specific `client_id`, supply email/password cred… - [Get access token by value](https://docs.extole.com/api-reference/authentication/get-access-token-by-value.md): Returns the metadata for the supplied token value (`type`, `client_id`, `identity_id`, `expires_in`, `scopes`). Use this when the caller has the token string and needs to introspect it; for the calling identity's own active token use `GET /v4/tokens` instead. - [Invalidate access token](https://docs.extole.com/api-reference/authentication/invalidate-access-token.md): Invalidates the supplied access token immediately. Subsequent requests using the same token return `401 invalid_access_token`. Returns `200` with an empty body on success. - [Exchange access token](https://docs.extole.com/api-reference/authentication/exchange-access-token.md): Exchanges the supplied access token for a fresh one with the same scopes and a renewed expiry. The original token is invalidated immediately on success. Use this to rotate long-lived integration tokens without re-authenticating. #### Content - [Fetch a rendered zone](https://docs.extole.com/api-reference/content/fetch-a-rendered-zone.md): Renders the named zone with no targeting data and returns its configured content. Useful for fetching static or anonymous zones from a server-rendered page or backend service. Identity (`email`, `partner_user_id`, `person_id`) and additional targeting fields are not accepted on this GET form - use `… - [Render a zone with targeting data](https://docs.extole.com/api-reference/content/render-a-zone-with-targeting-data.md): Renders the named zone, merging the request body's open data map into the targeting context. Recognised identity fields are `email`, `partner_user_id`, `person_id`, and `event_time` (ISO 8601). Additional keys are forwarded to the zone's targeting evaluator and creative renderer. Returns the zone's… - [Render a zone with the name and targeting data in the body](https://docs.extole.com/api-reference/content/render-a-zone-with-the-name-and-targeting-data-in-the-body.md): Renders a zone using a request body that carries both the zone name and the targeting data. Functionally equivalent to `POST /v5/zones/{zone_name}`; the path-based form is the recommended primary entry point. Use this form when the calling code constructs the full request payload upstream and prefer… #### Events - [Submit an event asynchronously](https://docs.extole.com/api-reference/events/submit-an-event-asynchronously.md): Submits a consumer event asynchronously. No per-request rate limit - use for high-volume or bulk integrations. May return 429 only if the downstream ingestion queue is saturated. Only `event_id` is returned; person identification occurs asynchronously after the request returns. - [Submit a named event asynchronously](https://docs.extole.com/api-reference/events/submit-a-named-event-asynchronously.md): Submits a specific named consumer event asynchronously. The event name is supplied in the URL path and the body is an open data map. No per-request rate limit. Returns `event_id` only; person identification occurs asynchronously. - [Submit an event](https://docs.extole.com/api-reference/events/submit-an-event.md): Submits a consumer event synchronously. Returns both `event_id` and `person_id`. Use when you need immediate confirmation that the event was processed and identity resolution has completed. For high-volume ingestion use `POST /v6/async-events` instead. - [Submit a named event](https://docs.extole.com/api-reference/events/submit-a-named-event.md): Submits a specific named consumer event synchronously. The event name is supplied in the URL path rather than in the request body, and the body is an open data map. #### Files - [List file assets](https://docs.extole.com/api-reference/files/list-file-assets.md): Returns a paginated list of file assets for the authenticated client. Filter by `name`, `statuses`, `tags`, or `user_id`. Results are ordered by creation date descending. Default page size is 100. - [Upload a file asset](https://docs.extole.com/api-reference/files/upload-a-file-asset.md): Uploads a file and creates a file asset record. The request is a multipart/form-data body containing the file content and optional metadata (name, tags, format). Supported formats: `CSV`, `PSV`, `JSON`, `JSONL`, `XLSX`. Once uploaded, the file asset can be used as the `data_source` of a batch job vi… - [Get a file asset](https://docs.extole.com/api-reference/files/get-a-file-asset.md): Returns the metadata record for a single file asset, including `status`, `review_status`, `size`, `format`, and `tags`. To retrieve the file content, use `GET /v6/files/{fileId}/download`. - [Update a file asset](https://docs.extole.com/api-reference/files/update-a-file-asset.md): Updates the mutable metadata of an existing file asset: `name` and `tags`. File content is immutable after upload. The file asset must be in `AVAILABLE` status; expired file assets cannot be updated. - [Delete a file asset](https://docs.extole.com/api-reference/files/delete-a-file-asset.md): Permanently deletes a file asset record and releases its stored content. This action is irreversible. Batch jobs that have already ingested this file asset are not affected. - [Download a file asset](https://docs.extole.com/api-reference/files/download-a-file-asset.md): Downloads the raw content of a file asset. The response body contains the file content in its original format (CSV, PSV, or JSON). Use the `limit` and `offset` parameters to paginate large files. Returns a 404 if the file asset has expired. - [Expire a file asset](https://docs.extole.com/api-reference/files/expire-a-file-asset.md): Marks a file asset as expired, releasing the stored file content. Expired file assets remain queryable but cannot be used as a batch job data source. Any batch jobs already referencing this file asset are not affected if they have already started processing. #### Persons - [Search for persons](https://docs.extole.com/api-reference/persons/search-for-persons.md): Searches for persons by identity key value or client-defined person keys (supply in `name:value` format, e.g. `partner_conversion_id:abc123`). Returns an array because the same key may resolve to multiple Extole profiles. Supply at least one search criterion via query parameters. - [Create a person](https://docs.extole.com/api-reference/persons/create-a-person.md): Creates a new person profile in the Extole platform and returns the persisted record with its server-assigned id. Use this to provision person profiles outside of the normal event-tracking flow (e.g. bulk imports). - [List partner keys](https://docs.extole.com/api-reference/persons/list-partner-keys.md): Returns the set of partner key names configured for the calling client. Partner keys are client-defined person identifier types (e.g. `partner_conversion_id`, `partner_shipment_id`) that supplement Extole's built-in identifiers. Supply the optional `include_campaign_ignoring_state` parameter to incl… - [Get a person](https://docs.extole.com/api-reference/persons/get-a-person.md): Returns the person profile for the specified `person_id`. The response includes the person's current identity key and value, locale settings, and version. Returns `403 person_not_found` if the person does not exist or is not accessible. - [Update a person](https://docs.extole.com/api-reference/persons/update-a-person.md): Updates the identity key value on the specified person profile. Returns `403 person_not_found` if the person does not exist or is not accessible. - [Get person block status](https://docs.extole.com/api-reference/persons/get-person-block-status.md): Returns the block record for the specified person, indicating whether they are blocked from participating in referral campaigns and the reason for the block. - [Update person block status](https://docs.extole.com/api-reference/persons/update-person-block-status.md): Updates the block record for the specified person. Set `type` to `EVENTS` to block event participation, `REWARDS` to block reward fulfilment, or `NONE` to remove any block. Supply an optional `reason` string for audit purposes. Returns the updated block record. - [List person data parameters](https://docs.extole.com/api-reference/persons/list-person-data-parameters.md): Returns all data parameters for the specified person, sorted by updated date in descending order. Use query parameters to filter by name or date range. Returns `403 person_not_found` if the person is not accessible. - [Create a person data parameter](https://docs.extole.com/api-reference/persons/create-a-person-data-parameter.md): Creates a new named data parameter for the specified person. Returns `400 data_already_exists` if a parameter with the same name already exists; use PUT to update an existing parameter. Returns `403 person_not_found` if the person is not accessible. - [Get a person data parameter](https://docs.extole.com/api-reference/persons/get-a-person-data-parameter.md): Returns the named data parameter for the specified person. Person data parameters are arbitrary key-value pairs attached to a person profile and can be used in campaign targeting and personalization. Returns `400 data_not_found` if the name does not exist, or `403 person_not_found` if the person is… - [Update a person data parameter](https://docs.extole.com/api-reference/persons/update-a-person-data-parameter.md): Updates the value of the named data parameter for the specified person. Returns `400 data_not_found` if the parameter does not exist, or `400 read_only_name` if the parameter name is read-only. Returns `403 person_not_found` if the person is not accessible. - [Delete a person data parameter](https://docs.extole.com/api-reference/persons/delete-a-person-data-parameter.md): Permanently deletes the named data parameter for the specified person. Returns `400 data_not_found` if the parameter does not exist. Returns `403 person_not_found` if the person is not accessible. - [Get identity history for a person](https://docs.extole.com/api-reference/persons/get-identity-history-for-a-person.md): Returns the chronological log of identity-merge and identity-link events for the specified person. Each entry records the event type, the previous identity key information, and the event date. Use this to audit how a person's unified profile evolved over time. - [List person journeys](https://docs.extole.com/api-reference/persons/list-person-journeys.md): Returns campaign journeys for the specified person, sorted by start date in descending order. A journey represents a person's participation lifecycle in a specific campaign (e.g. share, refer-a-friend, purchase). - [Get a person journey](https://docs.extole.com/api-reference/persons/get-a-person-journey.md): Returns the specified campaign journey for the given person, including the program, campaign, container, journey entry data, and timestamps. - [List person locations](https://docs.extole.com/api-reference/persons/list-person-locations.md): Returns request context location records for the specified person, sorted by created date in descending order. Locations capture the geographic context (country, region, city) observed at the time of person interactions. - [List person audience memberships](https://docs.extole.com/api-reference/persons/list-person-audience-memberships.md): Returns audience memberships for the specified person, sorted by created date in descending order. Each membership indicates which audiences the person currently belongs to. - [Create a person audience membership](https://docs.extole.com/api-reference/persons/create-a-person-audience-membership.md): Adds the specified person to an audience by creating a new audience membership. - [List person relationships](https://docs.extole.com/api-reference/persons/list-person-relationships.md): Returns the referral relationships for the specified person, showing advocate-friend connections created through campaign participation. Each entry carries the requested person's `my_role` (`ADVOCATE` or `FRIEND`) and the `other_person_id` on the other side, rather than being split into fixed advoca… - [List person rewards](https://docs.extole.com/api-reference/persons/list-person-rewards.md): Returns all rewards for the specified person, sorted by created date in descending order. Supports filtering by state, supplier type, and date range. - [Get a person reward](https://docs.extole.com/api-reference/persons/get-a-person-reward.md): Returns the specified reward for the given person, including its state, face value, and associated campaign. - [List person shareables](https://docs.extole.com/api-reference/persons/list-person-shareables.md): Returns all shareables for the specified person, sorted by created date in descending order. Each shareable is a unique referral link or code associated with a campaign. - [Create a person shareable](https://docs.extole.com/api-reference/persons/create-a-person-shareable.md): Creates a new shareable for the specified person. A shareable is a unique referral link or code associated with a campaign that the person can share to invite friends. - [Get a person shareable](https://docs.extole.com/api-reference/persons/get-a-person-shareable.md): Returns the shareable for the specified person identified by its share code. A shareable is a unique share link or code that allows a person to invite friends to participate in a referral campaign. - [Update a person shareable](https://docs.extole.com/api-reference/persons/update-a-person-shareable.md): Updates the content of an existing shareable identified by its share code for the specified person. - [List person shares](https://docs.extole.com/api-reference/persons/list-person-shares.md): Returns all share events for the specified person, sorted by created date in descending order. A share is recorded each time the person distributes a shareable link via a channel (social, email, etc.). - [Get a person share](https://docs.extole.com/api-reference/persons/get-a-person-share.md): Returns the specified share event for the given person, including its channel, shareable, and associated campaign journey. - [List person steps](https://docs.extole.com/api-reference/persons/list-person-steps.md): Returns campaign flow steps for the specified person, sorted by event date in descending order. Steps represent discrete tracked actions (e.g. conversion, share, reward earned) within the person's journey. - [Forward an identity profile to another identity profile](https://docs.extole.com/api-reference/persons/forward-an-identity-profile-to-another-identity-profile.md): Merges the specified identity profile into the target identity profile. All activity associated with the source identity profile, is forwarded to the target identity profile. After the operation the source profile is no longer independently addressable; lookups by any of its identifiers resolve to t… - [Delete a person audience membership](https://docs.extole.com/api-reference/persons/delete-a-person-audience-membership.md): Removes the specified person from the audience identified by the audience ID. #### Reward Suppliers - [Mark custom reward failed](https://docs.extole.com/api-reference/rewards/mark-custom-reward-failed.md): Marks the custom reward as failed, recording a fulfilment failure. - [Mark custom reward fulfilled](https://docs.extole.com/api-reference/rewards/mark-custom-reward-fulfilled.md): Marks the custom reward as fulfilled, signalling that the client system has completed fulfilment. - [Mark custom reward fulfilled and sent](https://docs.extole.com/api-reference/rewards/mark-custom-reward-fulfilled-and-sent.md): Marks the custom reward as fulfilled and sent to the participant. - [Mark custom reward redeemed](https://docs.extole.com/api-reference/rewards/mark-custom-reward-redeemed.md): Marks the custom reward as redeemed by the participant. - [Mark custom reward sent](https://docs.extole.com/api-reference/rewards/mark-custom-reward-sent.md): Marks the custom reward as sent to the participant. #### Rewards - [List rewards](https://docs.extole.com/api-reference/rewards/list-rewards.md): Returns reward records for the client matching the specified query parameters. - [Get reward state summary](https://docs.extole.com/api-reference/rewards/get-reward-state-summary.md): Returns aggregate state counts for rewards on this client (e.g. earned, fulfilled, cancelled). - [Get a reward](https://docs.extole.com/api-reference/rewards/get-a-reward.md): Returns the reward record for the specified reward id, including its current state and history. - [Update a reward](https://docs.extole.com/api-reference/rewards/update-a-reward.md): Updates attributes on the specified reward record. Returns the updated reward. - [Get reward cancels](https://docs.extole.com/api-reference/rewards/get-reward-cancels.md): Returns the cancellation history for the specified reward. - [Get reward expirations](https://docs.extole.com/api-reference/rewards/get-reward-expirations.md): Returns the expiration records for the specified reward. - [Get reward fails](https://docs.extole.com/api-reference/rewards/get-reward-fails.md): Returns the fulfilment failure history for the specified reward. - [Get reward fulfillments](https://docs.extole.com/api-reference/rewards/get-reward-fulfillments.md): Returns the fulfilment records for the specified reward. - [Get reward state history](https://docs.extole.com/api-reference/rewards/get-reward-state-history.md): Returns the full state-transition history for the specified reward. - [Get reward redeems](https://docs.extole.com/api-reference/rewards/get-reward-redeems.md): Returns the redemption records for the specified reward. - [Get reward revokes](https://docs.extole.com/api-reference/rewards/get-reward-revokes.md): Returns the revocation records for the specified reward. - [Get reward sends](https://docs.extole.com/api-reference/rewards/get-reward-sends.md): Returns the send events for the specified reward. - [Cancel a reward](https://docs.extole.com/api-reference/rewards/cancel-a-reward.md): Cancels the specified reward, preventing fulfilment. Returns the updated reward record. - [Expire a reward](https://docs.extole.com/api-reference/rewards/expire-a-reward.md): Marks the specified reward as expired. Returns the updated reward. - [Retry a reward](https://docs.extole.com/api-reference/rewards/retry-a-reward.md): Retries fulfilment of a previously failed reward. Returns the updated reward. - [Revoke a reward](https://docs.extole.com/api-reference/rewards/revoke-a-reward.md): Revokes the specified reward, marking it as invalid. Returns the updated reward. #### SFTP Servers - [List SFTP destinations](https://docs.extole.com/api-reference/sftp-servers/list-sftp-destinations.md): Returns all SFTP destination connection profiles configured for the client. - [Create an SFTP destination](https://docs.extole.com/api-reference/sftp-servers/create-an-sftp-destination.md): Creates a new SFTP destination connection profile used for automated report file delivery. Returns the created destination with its server-assigned id. - [Get an SFTP destination](https://docs.extole.com/api-reference/sftp-servers/get-an-sftp-destination.md): Returns the SFTP destination for the specified id. - [Update an SFTP destination](https://docs.extole.com/api-reference/sftp-servers/update-an-sftp-destination.md): Updates the SFTP destination connection profile. Only fields present in the request body are changed. Returns the updated destination. - [Delete an SFTP destination](https://docs.extole.com/api-reference/sftp-servers/delete-an-sftp-destination.md): Removes the SFTP destination connection profile. Returns the deleted destination. - [Sync an SFTP destination](https://docs.extole.com/api-reference/sftp-servers/sync-an-sftp-destination.md): Triggers an immediate synchronisation of the SFTP destination with its external server. Returns the updated destination after sync. - [Validate an SFTP destination](https://docs.extole.com/api-reference/sftp-servers/validate-an-sftp-destination.md): Validates the SFTP destination connection profile without persisting any changes. Returns any connectivity or configuration errors. ## OpenAPI Specs - [integration-consumer-to-extole](/api-reference/integration-consumer-to-extole.json) - [integration-server-to-extole](/api-reference/integration-server-to-extole.json) - [management](/api-reference/management.json)