Persons

Create a person shareable

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.

post/v5/persons/{person_id}/shareables

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v5/persons/:person_id/shareables/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

person_idstring required

The Extole unique profile identifier of this user at Extole.

Request body

codestring

dataobject

keystring

labelstring required

program_urlstring

Response

Successful response

codestring required

Unique shareable code used to generate this person's referral link.

created_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

dataobject required

Named data parameters attached to this shareable.

keystring required

Key identifying the shareable template or program slot.

labelstring required

Human-readable label for this shareable. Absent if no label was set.

linkstring required

Full referral link URL for this shareable.

updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Example response

{
  "created_date": "2025-10-24T02:00:00-07:00",
  "updated_date": "2025-10-24T02:00:00-07:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.