API docs by Redocly

Prosperi API (0.1.0)

Download OpenAPI specification:Download

other

Health Handler

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
platform
string (PlatformEnum)
Default: "web"
Enum: "web" "ios"
is_crypto_included
boolean (Is Crypto Included)
Default: true
quests_test
boolean (Quests Test)
Default: false
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
platform
string (PlatformEnum)
Default: "web"
Enum: "web" "ios"
is_crypto_included
boolean (Is Crypto Included)
Default: true
quests_test
boolean (Quests Test)
Default: false
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
level_id
required
string <uuid> (Level Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
level_id
required
string <uuid> (Level Id)
query Parameters
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Get User Balance Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Change User Balance Handler

path Parameters
user_id
required
integer (User Id)
Request Body schema: application/json
required
operation_type
required
string (OperationTypeEnum)
Enum: "buy" "sell"
required
Amount (number) or Amount (string) (Amount)

Responses

Request samples

Content type
application/json
{
  • "operation_type": "buy",
  • "amount": 0
}

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Get Books Handler

Retrieve a list of books.

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{}

Get Books Progress Handler

Retrieve user progress for each book.

You have to match user progress with books content.

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "books_progress": [
    ]
}

Get Book Handler

Retrieve book details.

book_id you can get from endpoint of list of books.

path Parameters
book_id
required
string <uuid> (Book Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Rich Dad, Poor Dad",
  • "image": "https://d28p64o139eetv.cloudfront.net/3710ac98-bcf1-4b08-86e0-df5c76b0a351.png",
  • "duration": "19 min",
  • "type": "finances",
  • "is_trending": true,
  • "description": "Rich Dad Poor Dad is Robert's story of growing up with two dads his real father and the father of his best friend, his rich dad and the ways in which both men shaped his thoughts about money and investing. The book explodes the myth that you need to earn a high income to be rich and explains the difference between working for money and having your money work for you.",
  • "author": "Robert T. Kiyosaki",
  • "skills": [
    ]
}

Get Book Chapters Handler

Retrieve all chapters of book.

path Parameters
book_id
required
string <uuid> (Book Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "chapters": [
    ]
}

Get Book Progress Handler

Retrieve user progress for specific book.

completed_chapter_ids list contains UUIDs of user's completed chapters in this book.

path Parameters
book_id
required
string <uuid> (Book Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "progress": 0.35,
  • "completed_chapter_ids": [
    ]
}

Get Chapter Handler

Retrieve chapter details.

path Parameters
book_id
required
string <uuid> (Book Id)
chapter_id
required
string <uuid> (Chapter Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Escaping the rat race: a tale of two mindsets",
  • "text": "Imagine growing up with not one but two father figures guiding your path. One, a beacon of traditional success with a PhD and a resume that sparkles with prestigious universities; the other, a man whose education halted before high school graduation. Yet, both carved their own versions of success in the professional world.\n\nHere's where it gets fascinating. Despite their hard work and dedication, these two men lived worlds apart financially. Kiyosaki's \"Poor Dad,\" the one with all the academic accolades, found himself ensnared in financial struggles, while \"Rich Dad,\" with less formal education, climbed his way to become one of Hawaii's wealthiest individuals. One left behind a legacy of wealth, the other, a pile of unpaid bills.\n\nFrom these two remarkable figures, Kiyosaki received a wealth of advice, as varied as their financial states. They both valued education, but their curricula on life and money couldn't have been more different.\n\nImagine Kiyosaki's dilemma as a young boy, caught between two divergent philosophies. On one hand, the traditional path preached by Poor Dad; on the other, Rich Dad's lessons on financial independence and the power of investing.\n\nKiyosaki found himself in a continuous state of reflection, comparing their advice on everything from the evils of money to the importance of financial literacy. This wasn't just about choosing whom to listen to; it was about forging his own path in the maze of financial wisdom."
}

Complete Chapter Handler

Endpoint to complete chapter.

Send a request when user has finished reading the chapter.

path Parameters
book_id
required
string <uuid> (Book Id)
chapter_id
required
string <uuid> (Chapter Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Book Recommendations Handler

Retrieve recommended books.

Endpoint always returns 2 objects in "book" key

path Parameters
book_id
required
string <uuid> (Book Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{}

other

Health Handler

Responses

Response samples

Content type
application/json
null

Attend Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Streak Handler

query Parameters
date
required
string (Date)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Current Streak Handler

query Parameters
Timezone (string) or Timezone (null) (Timezone)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Get Streak Updates Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

See Streak Updates Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Get Quests Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Create Quests Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Get Quests Updates Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

See Quests Updates Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Get Challenge Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Create Challenge Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Get Reward Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Claim Reward Handler

path Parameters
reward_id
required
string <uuid> (Reward Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

webhooks

Edit Image With Reference

Edit images using GPT Image model with reference images - queues the request for async processing.

Request Body schema: application/json
required
prompt
required
string (Prompt)
reference_image_urls
required
Array of strings (Reference Image Urls)
size
string (Size)
Default: "1024x1536"
quality
string (Quality)
Default: "medium"
model
string (Model)
Default: "gpt-image-1"
n
integer (N)
Default: 1
base_id
required
string (Base Id)
table_id
required
string (Table Id)
record_id
required
string (Record Id)
AspectRatio (string) or null
Default: "4x5"
add_safezone
boolean (Add Safezone)
Default: true
name
required
string (Name)
base_folder_id
required
string (Base Folder Id)
marketer
required
string (Marketer)

Responses

Request samples

Content type
application/json
{
  • "prompt": "string",
  • "reference_image_urls": [
    ],
  • "size": "1024x1536",
  • "quality": "medium",
  • "model": "gpt-image-1",
  • "n": 1,
  • "base_id": "string",
  • "table_id": "string",
  • "record_id": "string",
  • "aspect_ratio": "4x5",
  • "add_safezone": true,
  • "name": "string",
  • "base_folder_id": "string",
  • "marketer": "string"
}

Response samples

Content type
application/json
null

Proxy Image

Fetches an image from a provided URL and returns it as a PNG response.

query Parameters
url
required
string (Url)

Responses

Response samples

Content type
application/json
null

Get Mj Job

path Parameters
request_id
required
string (Request Id)

Responses

Response samples

Content type
application/json
null

Mj Job Image

Request Body schema: application/json
required
prompt
required
string (Prompt)

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Response samples

Content type
application/json
null

Form Created Handler

Request Body schema: application/json
required
Designer
required
string (Designer)
Format
required
string (Format)
Intro
required
string (Intro)
CreoName
required
string (Creoname)
Changes
required
string (Changes)
Language
required
string (Language)
Link on creo
required
string <uri> (Link On Creo) non-empty
source
required
string (CreoDestination)
Enum: "prosperi" "coursiv" "finelo" "another" "test"
CreoMarketer
string (Creomarketer)
Arrow code
required
string (Arrow Code)
Arrow
string (Arrow)
Recordid (string) or Recordid (null) (Recordid)
Compliancepoints (integer) or Compliancepoints (null) (Compliancepoints)

Responses

Request samples

Content type
application/json
{
  • "Designer": "string",
  • "Format": "string",
  • "Intro": "string",
  • "CreoName": "string",
  • "Changes": "string",
  • "Language": "string",
  • "Link on creo": "http://example.com",
  • "source": "prosperi",
  • "CreoMarketer": "string",
  • "Arrow code": "string",
  • "Arrow": "string",
  • "RecordId": "string",
  • "CompliancePoints": 0
}

Response samples

Content type
application/json
null

Creo Approved Handler

Request Body schema: application/json
required
creo_name
required
string (Creo Name)
creo_url
required
string <uri> (Creo Url) non-empty
ad_cab_ids
required
Array of strings (Ad Cab Ids)
record_id
required
string (Record Id)
table_id
required
string (Table Id)
base_id
required
string (Base Id)
is_single_file
boolean (Is Single File)
Default: false

Responses

Request samples

Content type
application/json
{
  • "creo_name": "string",
  • "creo_url": "http://example.com",
  • "ad_cab_ids": [
    ],
  • "record_id": "string",
  • "table_id": "string",
  • "base_id": "string",
  • "is_single_file": false
}

Response samples

Content type
application/json
null

Coursiv Creo Approved Handler

Request Body schema: application/json
required
creo_name
required
string (Creo Name)
creo_url
required
string <uri> (Creo Url) non-empty
ad_cab_ids
required
Array of strings (Ad Cab Ids)
record_id
required
string (Record Id)
table_id
required
string (Table Id)
base_id
required
string (Base Id)
is_single_file
boolean (Is Single File)
Default: false

Responses

Request samples

Content type
application/json
{
  • "creo_name": "string",
  • "creo_url": "http://example.com",
  • "ad_cab_ids": [
    ],
  • "record_id": "string",
  • "table_id": "string",
  • "base_id": "string",
  • "is_single_file": false
}

Response samples

Content type
application/json
null

Tiktok Creo Approved Handler

Request Body schema: application/json
required
creo_name
required
string (Creo Name)
creo_url
required
string <uri> (Creo Url) non-empty
ad_cab_ids
required
Array of strings (Ad Cab Ids)
record_id
required
string (Record Id)
table_id
required
string (Table Id)
base_id
required
string (Base Id)
is_single_file
boolean (Is Single File)
Default: false

Responses

Request samples

Content type
application/json
{
  • "creo_name": "string",
  • "creo_url": "http://example.com",
  • "ad_cab_ids": [
    ],
  • "record_id": "string",
  • "table_id": "string",
  • "base_id": "string",
  • "is_single_file": false
}

Response samples

Content type
application/json
null

Upload Handler

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Design Approved Handler

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Creo Merge Handler

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Creo Merge Finished Handler

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Creo Uploaded Handler

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Ad Approved Handler

Request Body schema: application/json
required
account_id
required
string (Account Id)
adset_name
required
string (Adset Name)
pixel_id
required
string (Pixel Id)
budget
required
integer (Budget)
bid_strategy
required
string (Bid Strategy)
saved_audience
required
string (Saved Audience)
campaign
required
string (Campaign)
link
required
string (Link)
headline
required
string (Headline)
message
required
string (Message)
media_ids
required
Array of strings (Media Ids)
page_id
required
string (Page Id)
instagram_actor_id
required
string (Instagram Actor Id)
type
required
string (Type)
table_id
required
string (Table Id)
record_id
required
string (Record Id)

Responses

Request samples

Content type
application/json
{
  • "account_id": "string",
  • "adset_name": "string",
  • "pixel_id": "string",
  • "budget": 0,
  • "bid_strategy": "string",
  • "saved_audience": "string",
  • "campaign": "string",
  • "link": "string",
  • "headline": "string",
  • "message": "string",
  • "media_ids": [
    ],
  • "page_id": "string",
  • "instagram_actor_id": "string",
  • "type": "string",
  • "table_id": "string",
  • "record_id": "string"
}

Response samples

Content type
application/json
null

Campaign Approved Handler

Request Body schema: application/json
required
account_id
required
string (Account Id)
adset_name
required
string (Adset Name)
pixel_id
required
string (Pixel Id)
budget
required
integer (Budget)
bid_strategy
required
string (Bid Strategy)
Bid Amount (integer) or Array of Bid Amount (integers) or Bid Amount (null) (Bid Amount)
campaign
required
string (Campaign)
link
required
string (Link)
headline
required
string (Headline)
message
required
string (Message)
media_ids
required
Array of strings (Media Ids)
page_id
required
string (Page Id)
instagram_actor_id
required
string (Instagram Actor Id)
table_id
required
string (Table Id)
base_id
required
string (Base Id)
record_id
required
string (Record Id)
bidding_type
required
string (Bidding Type)
Geo (string) or Array of Geo (objects) or Geo (null) (Geo)
Array of Lookalike (objects) or Lookalike (null) (Lookalike)
exclude_audience
required
string (Exclude Audience)
Array of Interest (objects) or Interest (null) (Interest)
search_by_name
required
boolean (Search By Name)
Array of Locales (any) or Locales (null) (Locales)
Type (string) or Type (null) (Type)
Geo Id (string) or Geo Id (null) (Geo Id)
Launch Type (string) or Launch Type (null) (Launch Type)
Start Time (string) or Start Time (null) (Start Time)
Product (string) or Product (null) (Product)

Responses

Request samples

Content type
application/json
{
  • "account_id": "string",
  • "adset_name": "string",
  • "pixel_id": "string",
  • "budget": 0,
  • "bid_strategy": "string",
  • "bid_amount": 0,
  • "campaign": "string",
  • "link": "string",
  • "headline": "string",
  • "message": "string",
  • "media_ids": [
    ],
  • "page_id": "string",
  • "instagram_actor_id": "string",
  • "table_id": "string",
  • "base_id": "string",
  • "record_id": "string",
  • "bidding_type": "string",
  • "geo": "string",
  • "lookalike": [
    ],
  • "exclude_audience": "string",
  • "interest": [
    ],
  • "search_by_name": true,
  • "locales": [
    ],
  • "type": "string",
  • "geo_id": "string",
  • "launch_type": "string",
  • "start_time": "2019-08-24T14:15:22Z",
  • "product": "string"
}

Response samples

Content type
application/json
null

Report Loaded Handler

Request Body schema: application/json
required
table_id
required
string (Table Id)
cab
required
string (Cab)
required
object (Video Records)

Responses

Request samples

Content type
application/json
{
  • "table_id": "string",
  • "cab": "string",
  • "video_records": { }
}

Response samples

Content type
application/json
null

Check Creos Existence Handler

Request Body schema: application/json
required
creo_marketer
required
string (Creo Marketer)
base_folder_id
required
string (Base Folder Id)
versioned_concepts_enabled
required
boolean (Versioned Concepts Enabled)
required
object (Grouped Records)

Responses

Request samples

Content type
application/json
{
  • "creo_marketer": "string",
  • "base_folder_id": "string",
  • "versioned_concepts_enabled": true,
  • "grouped_records": {
    }
}

Response samples

Content type
application/json
null

Async Search File

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Async Check Creos Existence Handler

Request Body schema: application/json
required
creo_marketer
required
string (Creo Marketer)
base_folder_id
required
string (Base Folder Id)
versioned_concepts_enabled
required
boolean (Versioned Concepts Enabled)
required
object (Grouped Records)

Responses

Request samples

Content type
application/json
{
  • "creo_marketer": "string",
  • "base_folder_id": "string",
  • "versioned_concepts_enabled": true,
  • "grouped_records": {
    }
}

Response samples

Content type
application/json
null

Check Creo Overlay

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Upload Creo To Drive Handler

Request Body schema: application/json
required
file_url
required
string (File Url)
name
required
string (Name)
folder_id
required
string (Folder Id)
mime_type
required
string (Mime Type)
type
required
string (Type)
language
required
string (Language)
Aspect Ratio (string) or Aspect Ratio (null) (Aspect Ratio)
is_checked
boolean (Is Checked)
Default: false
alpha
boolean (Alpha)
Default: false

Responses

Request samples

Content type
application/json
{
  • "file_url": "string",
  • "name": "string",
  • "folder_id": "string",
  • "mime_type": "string",
  • "type": "string",
  • "language": "string",
  • "aspect_ratio": "string",
  • "is_checked": false,
  • "alpha": false
}

Response samples

Content type
application/json
null

Generate Creo Name

Request Body schema: application/json
required
prompt
required
string (Prompt)
base_id
required
string (Base Id)
table_id
required
string (Table Id)

Responses

Request samples

Content type
application/json
{
  • "prompt": "string",
  • "base_id": "string",
  • "table_id": "string"
}

Response samples

Content type
application/json
null

Launch Google

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Preview Creos

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Overlay Creos

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Phk Creos

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Alpha Creos

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Overlay Creos Pack

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Creo Preview Finished

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Creo Overlay Finished

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Creo Phk Status

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Generate Thumbnail

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Validate Creative Fatigue

Responses

Response samples

Content type
application/json
null

Create Creative Fatigue

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Insta Post

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Insta Reels

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Fb Post

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Fb Reels

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Youtube Post

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Tiktok Post

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Google Square

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Tiktok Launch

Request Body schema: application/json
required
advertiser_id
required
string (Advertiser Id)
campaign_name
required
string (Campaign Name)
adgroup_name
required
string (Adgroup Name)
budget
required
integer (Budget)
audience_id
required
string (Audience Id)
schedule_start_time
required
string (Schedule Start Time)
pixel_id
required
string (Pixel Id)
media_ids
required
Array of strings (Media Ids)
identity_id
required
string (Identity Id)
ad_text
required
string (Ad Text)
landing_page_url
required
string (Landing Page Url)
campaign_type
required
string (Campaign Type)
required
Array of objects (Utm Params)
bid_strategy
string (Bid Strategy)
Default: "lowest"
Bid Amount (number) or Bid Amount (null) (Bid Amount)

Responses

Request samples

Content type
application/json
{
  • "advertiser_id": "string",
  • "campaign_name": "string",
  • "adgroup_name": "string",
  • "budget": 0,
  • "audience_id": "string",
  • "schedule_start_time": "string",
  • "pixel_id": "string",
  • "media_ids": [
    ],
  • "identity_id": "string",
  • "ad_text": "string",
  • "landing_page_url": "string",
  • "campaign_type": "string",
  • "utm_params": [
    ],
  • "bid_strategy": "lowest",
  • "bid_amount": 0
}

Response samples

Content type
application/json
null

Arcads Script

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Arcads Script Update

path Parameters
script_id
required
string (Script Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Arcads Script Audio

path Parameters
script_id
required
string (Script Id)

Responses

Response samples

Content type
application/json
null

Arcads Generation

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Arcads Video Update

path Parameters
video_id
required
string (Video Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Translate

Request Body schema: application/json
required
texts
required
Array of strings (Texts)
targetLanguage
required
string (Targetlanguage)

Responses

Request samples

Content type
application/json
{
  • "texts": [
    ],
  • "targetLanguage": "string"
}

Response samples

Content type
application/json
null

Ae Translate

Asynchronous endpoint to translate texts to the target language while preserving structure.

Request Body schema: application/json
required
texts
required
Array of strings (Texts)
targetLanguage
required
string (Targetlanguage)

Responses

Request samples

Content type
application/json
{
  • "texts": [
    ],
  • "targetLanguage": "string"
}

Response samples

Content type
application/json
null

Fb Ads Library

Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Challenges Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Challenge Handler

path Parameters
challenge_id
required
string <uuid> (Challenge Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Challenge Join Handler

path Parameters
challenge_id
required
string <uuid> (Challenge Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Challenge Reward Handler

path Parameters
challenge_id
required
string <uuid> (Challenge Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Task Handler

path Parameters
task_id
required
string <uuid> (Task Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Task Complete Handler

path Parameters
task_id
required
string <uuid> (Task Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Request Body schema: application/json
required
score
required
number (Score) [ 0.8 .. 1 ]

Responses

Request samples

Content type
application/json
{
  • "score": 0.8
}

Response samples

Content type
application/json
null

health

email_marketing_health_retrieve

Responses

other

email_marketing_root_create

path Parameters
user_id
required
integer
Request Body schema:
required
user_id
required
integer
user_action
required
string
url
string
Default: ""
attribution_id
string or null
Default: ""

Responses

Request samples

Content type
{
  • "user_id": 0,
  • "user_action": "string",
  • "url": "",
  • "attribution_id": ""
}

Response samples

Content type
application/json
{
  • "user_id": 0,
  • "user_action": "string",
  • "url": "",
  • "attribution_id": ""
}

sendEvent

email_marketing_sendEvent_create

Responses

subscribe

email_marketing_subscribe_create

Responses

unsubscribe

email_marketing_unsubscribe_create

Responses

update

email_marketing_update_create

Responses

health

engagement_health_retrieve

Responses

streaks

engagement_streaks_actions_create

Responses

engagement_streaks_internal_profiles_retrieve

path Parameters
user_id
required
integer

Responses

engagement_streaks_profiles_retrieve

path Parameters
user_id
required
integer

Responses

engagement_streaks_profiles_popup_retrieve

path Parameters
user_id
required
integer

Responses

engagement_streaks_profiles_popup_create

path Parameters
user_id
required
integer

Responses

engagement_streaks_profiles_streak_dates_retrieve

path Parameters
user_id
required
integer

Responses

engagement_streaks_profiles_updates_retrieve

path Parameters
user_id
required
integer

Responses

engagement_streaks_rewards_retrieve

Responses

engagement_streaks_rewards_calculations_retrieve

Responses

engagement_streaks_transactions_create

Responses

get_geo

geo_get_geo_retrieve

Responses

healthcheck

geo_healthcheck_retrieve

Responses

other

geo_root_retrieve

Responses

v2

geo_v2_retrieve

Responses

invoices

Get Invoice Link

path Parameters
order_id
required
string <uuid> (Order Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
{
  • "link": "string"
}

Get Invoice File

The endpoint is under cloudfront

path Parameters
order_id
required
string <uuid> (Order Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "file": "string"
}

other

Health Handler

Responses

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Get Leaderboard Handler

query Parameters
username
required
string (Username)
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

See Leaderboard Updates Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Get User League Handler

query Parameters
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Get User League V2 Handler

query Parameters
username
required
string (Username)
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Get Climb Status Handler

query Parameters
username
required
string (Username)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

See Rank Update Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Get Climb Handler

query Parameters
username
required
string (Username)
new_images_enabled
boolean (New Images Enabled)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
is_crypto_included
boolean (Is Crypto Included)
Default: true
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
is_crypto_included
boolean (Is Crypto Included)
Default: true
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
is_crypto_included
boolean (Is Crypto Included)
Default: true
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
query Parameters
show_video_lessons
boolean (Show Video Lessons)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
lesson_id
required
string <uuid> (Lesson Id)
query Parameters
ignore_choice_pages
boolean (Ignore Choice Pages)
Default: true
styled_text
boolean (Styled Text)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
video_lesson_id
required
string <uuid> (Video Lesson Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
quiz_id
required
string <uuid> (Quiz Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
quiz_id
required
string <uuid> (Quiz Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
quiz_id
required
string <uuid> (Quiz Id)
question_id
required
string <uuid> (Question Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
choice_id
required
string <uuid> (Choice Id)

Responses

Request samples

Content type
application/json
{
  • "choice_id": "e1722336-84a4-4cbc-a899-9fd1168d8a01"
}

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
lesson_id
required
string <uuid> (Lesson Id)
page_id
required
string <uuid> (Page Id)
query Parameters
ignore_choice_pages
boolean (Ignore Choice Pages)
Default: true
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
lesson_id
required
string <uuid> (Lesson Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
chapter_id
required
string <uuid> (Chapter Id)
video_lesson_id
required
string <uuid> (Video Lesson Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
quiz_attempt_id
required
string <uuid> (Quiz Attempt Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
show_video_lessons
boolean (Show Video Lessons)
Default: false
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Request Body schema: application/json
required
target_lessons
required
integer (Target Lessons) [ 1 .. 99 ]
timezone
required
string (Timezone)

Responses

Request samples

Content type
application/json
{
  • "target_lessons": 1,
  • "timezone": "string"
}

Response samples

Content type
application/json
null

Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Request Body schema: application/json
required
target_lessons
required
integer (Target Lessons) [ 1 .. 99 ]

Responses

Request samples

Content type
application/json
{
  • "target_lessons": 1
}

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
lesson_id
required
string <uuid> (Lesson Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
path_id
required
string <uuid> (Path Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
is_crypto_included
boolean (Is Crypto Included)
Default: true
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
is_crypto_included
boolean (Is Crypto Included)
Default: true
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
path_id
required
string <uuid> (Path Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
path_id
required
string <uuid> (Path Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
path_id
required
string <uuid> (Path Id)
header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
is_crypto_included
boolean (Is Crypto Included)
Default: true
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Handler

query Parameters
locale
required
string (LocaleEnum)
Enum: "en" "es" "fr" "de" "pt" … 2 more

Responses

Response samples

Content type
application/json
null

Handler

Request Body schema: application/json
required
object (Data)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)

Responses

Response samples

Content type
application/json
null

Handler

path Parameters
course_id
required
string <uuid> (Course Id)
Request Body schema: application/json
required
data
required
object (Data)
level
required
string (Level)
is_trending
required
boolean (Is Trending)
type
required
string (Type)
is_active
required
boolean (Is Active)
required
object (Is Voiced)

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "level": "string",
  • "is_trending": true,
  • "type": "string",
  • "is_active": true,
  • "is_voiced": {
    }
}

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Events Handler

header Parameters
Cloudfront-Viewer-Country (string) or Cloudfront-Viewer-Country (null) (Cloudfront-Viewer-Country)
X-Zmrn-User-Id (string) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
User-Agent (string) or User-Agent (null) (User-Agent)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
bundle_id
required
string <uuid> (Bundle Id)
event_name
required
string (Event Name)
required
Event Time (number) or Event Time (integer) (Event Time)
location_url
required
string <uri> (Location Url) non-empty
Country (string) or Country (null) (Country)
required
object (UserIdentity)
Test Event Code (string) or Test Event Code (null) (Test Event Code)
extra
required
object (Extra)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60",
  • "event_name": "string",
  • "event_time": 0,
  • "location_url": "http://example.com",
  • "country": "string",
  • "identity": {
    },
  • "test_event_code": "string",
  • "extra": { }
}

Response samples

Content type
application/json
null

Bundle Retrieve Handler

path Parameters
bundle_id
required
string <uuid> (Bundle Id)

Responses

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Init Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Request Body schema: application/json
required
required
Array of objects (Messages)

Responses

Request samples

Content type
application/json
{
  • "messages": [
    ]
}

Response samples

Content type
application/json
null

Get Messages Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Create Message Handler

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)
Request Body schema: application/json
required
content
required
string (Content) <= 300 characters

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Message Event Handler

Request Body schema: application/json
required
Email (string) or Email (null) (Email)
eventName
required
string (Eventname)
provider_occurred_at
required
string (Provider Occurred At)
dataFields
required
object (Datafields)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "eventName": "string",
  • "provider_occurred_at": "string",
  • "dataFields": { }
}

Response samples

Content type
application/json
null

Device Event Handler

Request Body schema: application/json
required
devices
required
Array of any (Devices)
userId
required
string (Userid)
email
required
string (Email)

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ],
  • "userId": "string",
  • "email": "string"
}

Response samples

Content type
application/json
null

User Action Handler

Request Body schema: application/json
required
action
required
string (Action)
user_id
required
integer (User Id)
url
required
string (Url)
gender
string (Gender)
Default: "all"
Attribution Id (string) or Attribution Id (null) (Attribution Id)
properties
object (Properties)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "action": "string",
  • "user_id": 0,
  • "url": "string",
  • "gender": "all",
  • "attribution_id": "string",
  • "properties": { }
}

Response samples

Content type
application/json
null

health

Health check endpoint

Simple health check endpoint

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

offers

Get offers

Get offers by product type and pricing representation OR by the list of offer_ids

query Parameters
offers_ids
string non-empty
pricing_repr
string non-empty
Enum: "daily" "weekly" "monthly" "yearly" "quarterly"
  • daily - daily
  • weekly - weekly
  • monthly - monthly
  • yearly - yearly
  • quarterly - quarterly
product_type
string [ 1 .. 100 ] characters
header Parameters
HTTP_CLOUDFRONT_VIEWER_COUNTRY
string

Country code of the user

HTTP_PAYWALL_CONFIG_ID
string

Paywall config id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get offer by id

Get offer by id

path Parameters
offer_id
required
string
header Parameters
HTTP_CLOUDFRONT_VIEWER_COUNTRY
string

Country code of the user

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "title": "string",
  • "description": "string",
  • "weight": 1,
  • "is_trial": true,
  • "position": 2147483647,
  • "currency": "string",
  • "period": 0,
  • "pricings": [
    ],
  • "quantity": 2147483647,
  • "product_type": "string"
}

Get offer and pricing by ids

Get offer and pricing by ids

path Parameters
offer_id
required
string
pricing_id
required
string
header Parameters
HTTP_CLOUDFRONT_VIEWER_COUNTRY
string

Country code of the user

Responses

Response samples

Content type
application/json
{
  • "offer": {
    },
  • "pricing": [
    ]
}

Get offer only by id (internal)

Get offer only by id (internal)

path Parameters
offer_id
required
string

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "is_trial": true,
  • "product_name": "string",
  • "product_type": "string",
  • "type": "one_off"
}

Calculate price with VAT

Calculate price with VAT

Responses

Response samples

Content type
application/json
{
  • "result": 0
}

Get pricing by id

Get pricing by id

path Parameters
pricing_id
required
string
header Parameters
HTTP_CLOUDFRONT_VIEWER_COUNTRY
string

Country code of the user

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "price": 0,
  • "discount_price": 0,
  • "discount_price_vat_amount": 9223372036854776000,
  • "currency": "string",
  • "discount": 100,
  • "position": 2147483647,
  • "weight": 1,
  • "product_id": "string",
  • "trial_pricing": {
    },
  • "original_pricing": {
    },
  • "vat": 2147483647,
  • "vat_rate": "string"
}

Get product by id

Get product by id

path Parameters
product_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "price": 0,
  • "discount_price": 0,
  • "discount_price_vat_amount": 9223372036854776000,
  • "period": 2147483647,
  • "has_trial": "string",
  • "trial_pricing": {
    },
  • "original_pricing": {
    },
  • "vat": 2147483647,
  • "vat_rate": "string",
  • "product": "string"
}

other

Health Handler

Responses

Response samples

Content type
application/json
null

Create Purchase

Create purchase

Note: for OneOff case we expect complete creation at once with user_id in data without patch request in future

:param data: :param locale: :return:

header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
purchase_token
required
string (Purchase Token)
User Id (integer) or User Id (null) (User Id)
currency
required
string (Currency)
amount
required
integer (Amount)
Subscription Id (string) or Subscription Id (null) (Subscription Id)
Product Id (string) or Product Id (null) (Product Id)

Responses

Request samples

Content type
application/json
{
  • "purchase_token": "string",
  • "user_id": 0,
  • "currency": "string",
  • "amount": 0,
  • "subscription_id": "string",
  • "product_id": "string"
}

Response samples

Content type
application/json
null

Update Purchase

Update purchase

:param data: :param locale: :param attribution_id: :return:

header Parameters
x-zmrn-attribution-id
string (X-Zmrn-Attribution-Id)
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
purchase_token
required
string (Purchase Token)
user_id
required
integer (User Id)
Subscription Id (string) or Subscription Id (null) (Subscription Id)
Product Id (string) or Product Id (null) (Product Id)

Responses

Request samples

Content type
application/json
{
  • "purchase_token": "string",
  • "user_id": 0,
  • "subscription_id": "string",
  • "product_id": "string"
}

Response samples

Content type
application/json
null

Notification Callback Handler

header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Create Purchase Handler

header Parameters
Accept-Language
string (Accept-Language)
Default: en
Request Body schema: application/json
required
transaction_id
required
string (Transaction Id)
User Id (integer) or User Id (null) (User Id)
Currency (string) or Currency (null) (Currency)
Amount (integer) or Amount (null) (Amount)

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "user_id": 0,
  • "currency": "str",
  • "amount": 0
}

Response samples

Content type
application/json
null

Update Purchase Handler

header Parameters
x-zmrn-attribution-id
string (X-Zmrn-Attribution-Id)
Request Body schema: application/json
required
transaction_id
required
string (Transaction Id)
user_id
required
integer (User Id)
currency
required
string (Currency) <= 3 characters
amount
required
integer (Amount)

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "user_id": 0,
  • "currency": "str",
  • "amount": 0
}

Response samples

Content type
application/json
null

Notification Event Handler

Request Body schema: application/json
required
signedPayload
required
string (Signedpayload)

Responses

Request samples

Content type
application/json
{
  • "signedPayload": "string"
}

Response samples

Content type
application/json
null

callbacks

Subscription Callback Handler

header Parameters
solidgate-event-id
required
string <uuid> (Solidgate-Event-Id)
merchant
required
string (Merchant)
signature
required
string (Signature)
Request Body schema: application/json
required
object (Payload)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Chargeback Callback Handler

header Parameters
solidgate-event-id
required
string <uuid> (Solidgate-Event-Id)
Request Body schema: application/json
required
object (Data)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Fraud Alerts Handler

header Parameters
solidgate-event-id
required
string <uuid> (Solidgate-Event-Id)
Request Body schema: application/json
required
object (Data)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Order Callback Handler

header Parameters
solidgate-event-id
required
string <uuid> (Solidgate-Event-Id)
merchant
required
string (Merchant)
signature
required
string (Signature)
Request Body schema: application/json
required
object (Payload)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

cards

User Saved Card

path Parameters
user_id
required
integer (User Id)
query Parameters
Card Type (string) or Card Type (null) (Card Type)

Responses

Response samples

Content type
application/json
null

User Card Token

path Parameters
user_id
required
integer (User Id)

Responses

Response samples

Content type
application/json
null

forms

Form Handler

Request Body schema: application/json
required
user_id
required
integer (User Id)
offer_id
required
string <uuid> (Offer Id)
pricing_id
required
string <uuid> (Pricing Id)
Language (string) or Language (null) (Language)
email
required
string <email> (Email)
lazy
boolean (Lazy)
Default: true
country_code
required
string (Country Code) = 3 characters
order_type
string (OrderType)
Default: "FIRST"
Enum: "FIRST" "TWO_STEP_PAYMENT" "RECURRING" "ONECLICK"

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf",
  • "pricing_id": "65de3aea-aee1-459d-a8d8-f0fd9d8f340d",
  • "language": "string",
  • "email": "user@example.com",
  • "lazy": true,
  • "country_code": "str",
  • "order_type": "FIRST"
}

Response samples

Content type
application/json
null

Form Status Handler

path Parameters
order_id
required
string <uuid> (Order Id)
query Parameters
user_id
required
integer (User Id)

Responses

Response samples

Content type
application/json
null

Form Handler

Request Body schema: application/json
required
required
object (FormPurchase)
required
OneClickPurchaseUnauthorized (object) or FormPurchase (object) (Payload)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "payload": {
    }
}

Response samples

Content type
application/json
null

Form Status Handler

path Parameters
form_id
required
string <uuid> (Form Id)

Responses

Response samples

Content type
application/json
null

internal

Get Orders By User Id Handler

header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Orders With Transaction Amount By User Ids

Request Body schema: application/json
required
user_ids
required
Array of integers (User Ids)

Responses

Request samples

Content type
application/json
{
  • "user_ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Chargebacks By User Id Handler

header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Apm Disputes By User Id Handler

header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

User Card Token

path Parameters
user_id
required
integer (User Id)

Responses

Response samples

Content type
application/json
null

User Subscription Status

path Parameters
subscription_id
required
string (Subscription Id)

Responses

Response samples

Content type
application/json
null

Get User Subscriptions

header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Get Order By Reference Id

path Parameters
reference_id
required
string (Reference Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference_id": "97c1ff22-6e4f-4821-b1d3-5236781d37b8",
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "amount": 0,
  • "currency": "string",
  • "payment_method": "string",
  • "type": "string",
  • "status": "string",
  • "purchased_at": "string",
  • "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
  • "card_info": { },
  • "offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf"
}

Get Latest Order By Reference Id

path Parameters
reference_id
required
string (Reference Id)

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference_id": "97c1ff22-6e4f-4821-b1d3-5236781d37b8",
  • "user_id": 0,
  • "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
  • "country": "string",
  • "region": "string",
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "amount": 0,
  • "type": "string",
  • "currency": "string",
  • "offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf",
  • "pricing_id": "65de3aea-aee1-459d-a8d8-f0fd9d8f340d",
  • "payment_type": "string",
  • "status": "string",
  • "transactions": [
    ]
}

Get Refunded Order By Reference Id

path Parameters
reference_id
required
string (Reference Id)

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference_id": "97c1ff22-6e4f-4821-b1d3-5236781d37b8",
  • "user_id": 0,
  • "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
  • "country": "string",
  • "region": "string",
  • "vat_amount": 0,
  • "vat_rate": 0,
  • "amount": 0,
  • "type": "string",
  • "currency": "string",
  • "offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf",
  • "pricing_id": "65de3aea-aee1-459d-a8d8-f0fd9d8f340d",
  • "payment_type": "string",
  • "status": "string",
  • "transactions": [
    ]
}

Get Order True Amount And Refunded Amount

path Parameters
reference_id
required
string (Reference Id)

Responses

Response samples

Content type
application/json
{
  • "true_amount": 0,
  • "residual_refund": 0
}

orders

One Click Payment Handler

Request Body schema: application/json
required
user_id
required
integer (User Id)
offer_id
required
string (Offer Id)
pricing_id
required
string (Pricing Id)

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "offer_id": "string",
  • "pricing_id": "string"
}

Response samples

Content type
application/json
null

Get Order Status Handler

path Parameters
order_id
required
string <uuid> (Order Id)

Responses

Response samples

Content type
application/json
null

Get Payment Type

header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
{
  • "payment_type": "PAYPAL"
}

Get Payment History

query Parameters
Array of Statuses (strings) or Statuses (null) (Statuses)
header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
{
  • "card_info": {
    },
  • "orders": [
    ]
}

One Click Payment Handler V2

Request Body schema: application/json
required
user_id
required
integer (User Id)
offer_id
required
string (Offer Id)
pricing_id
required
string (Pricing Id)
user_uid
required
string <uuid> (User Uid)

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "offer_id": "string",
  • "pricing_id": "string",
  • "user_uid": "f6a0c71c-a38a-4fc2-9782-e66a01572b15"
}

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

subscriptions

Switch Subscription Product

path Parameters
subscription_id
required
string (Subscription Id)
header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)
Request Body schema: application/json
required
product_id
required
string <uuid> (Product Id)

Responses

Request samples

Content type
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1"
}

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Init Handler

header Parameters
x-zmrn-attribution-id
required
string <uuid> (X-Zmrn-Attribution-Id)
x-zmrn-country-code
string (X-Zmrn-Country-Code)
Request Body schema: application/json
required
Fbclid (string) or Fbclid (null) (Fbclid)
Utm Source (string) or Utm Source (null) (Utm Source)
Utm Campaign (string) or Utm Campaign (null) (Utm Campaign)
Utm Adset (string) or Utm Adset (null) (Utm Adset)
Utm Ad (string) or Utm Ad (null) (Utm Ad)
Utm Adgroup (string) or Utm Adgroup (null) (Utm Adgroup)
Utm Keyword (string) or Utm Keyword (null) (Utm Keyword)
Utm Placement (string) or Utm Placement (null) (Utm Placement)
Extra (object) or Extra (null) (Extra)
timestamp
required
number (Timestamp)

Responses

Request samples

Content type
application/json
{
  • "fbclid": "string",
  • "utm_source": "string",
  • "utm_campaign": "string",
  • "utm_adset": "string",
  • "utm_ad": "string",
  • "utm_adgroup": "string",
  • "utm_keyword": "string",
  • "utm_placement": "string",
  • "extra": { },
  • "timestamp": 0
}

Response samples

Content type
application/json
null

Update Properties Handler

header Parameters
x-zmrn-attribution-id
required
string <uuid> (X-Zmrn-Attribution-Id)
x-zmrn-country-code
string (X-Zmrn-Country-Code)
Request Body schema: application/json
required
properties
required
object (Properties)

Responses

Request samples

Content type
application/json
{
  • "properties": { }
}

Response samples

Content type
application/json
null

Update Or Create Attribution Handler

header Parameters
x-zmrn-attribution-id
required
string <uuid> (X-Zmrn-Attribution-Id)
x-zmrn-country-code
string (X-Zmrn-Country-Code)
Request Body schema: application/json
required
Click Id (string) or Click Id (null) (Click Id)
Utm Source (string) or Utm Source (null) (Utm Source)
Utm Campaign (string) or Utm Campaign (null) (Utm Campaign)
Utm Adset (string) or Utm Adset (null) (Utm Adset)
Utm Ad (string) or Utm Ad (null) (Utm Ad)
Utm Adgroup (string) or Utm Adgroup (null) (Utm Adgroup)
Utm Keyword (string) or Utm Keyword (null) (Utm Keyword)
Utm Placement (string) or Utm Placement (null) (Utm Placement)
properties
object (Properties)
Default: {}
object (Extra)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "click_id": "string",
  • "utm_source": "string",
  • "utm_campaign": "string",
  • "utm_adset": "string",
  • "utm_ad": "string",
  • "utm_adgroup": "string",
  • "utm_keyword": "string",
  • "utm_placement": "string",
  • "properties": { },
  • "extra": {
    }
}

Response samples

Content type
application/json
null

Get Attribution Handler

path Parameters
attribution_id
required
string <uuid> (Attribution Id)

Responses

Response samples

Content type
application/json
null

Get Attribution By User Id Handler

path Parameters
user_id
required
integer (User Id)
header Parameters
Authorization
string (Authorization)

Responses

Response samples

Content type
application/json
null

internal

Get Subscription By Reference Id

path Parameters
reference_id
required
string (Reference Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "active",
  • "reference_id": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "expired_at": "2019-08-24T14:15:22Z",
  • "next_charge_at": "2019-08-24T14:15:22Z",
  • "product": { },
  • "product_type": "string",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "cancellation_reason": "string",
  • "source": "string"
}

Get Subscription By Reference Id Normalized

path Parameters
reference_id
required
string (Reference Id)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "string",
  • "reference_id": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "expired_at": "2019-08-24T14:15:22Z",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "next_charge_at": "2019-08-24T14:15:22Z",
  • "product": { },
  • "is_final_offer": true,
  • "trial_mode": true,
  • "cancel_code": "string",
  • "source": "string"
}

Get Subscriptions

query Parameters
user_id
required
integer (User Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

other

Health Handler

Responses

Response samples

Content type
application/json
null

subscriptions

Get Subscriptions

query Parameters
User Id (integer) or User Id (null) (User Id)
Deprecated
header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
null

Perform Unsubscribe

header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)
Request Body schema: application/json
required
subscription_id
required
string <uuid> (Subscription Id)

Responses

Request samples

Content type
application/json
{
  • "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627"
}

Response samples

Content type
application/json
null

Perform Restore

header Parameters
x-zmrn-user-id
required
integer (X-Zmrn-User-Id)
Request Body schema: application/json
required
subscription_id
required
string <uuid> (Subscription Id)

Responses

Request samples

Content type
application/json
{
  • "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627"
}

Response samples

Content type
application/json
null

users

User Has Subscription

path Parameters
user_id
required
integer (User Id)
query Parameters
ProductType (string) or Product Type (null) (Product Type)

Responses

Response samples

Content type
application/json
null

other

Health Handler

Responses

Response samples

Content type
application/json
null

Get News Deprecated

Responses

Response samples

Content type
application/json
null

Get Offers Deprecated

Responses

Response samples

Content type
application/json
null

Process Payment Deprecated

Responses

Response samples

Content type
application/json
null

User Has Subscription Deprecated

Responses

Response samples

Content type
application/json
null

reports

Get Reports

Get user's upsell reports

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Recommended Upsell

Get recommended upsell based on user's attributions

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "upsell_type": "string",
  • "bullet_list": [
    ],
  • "reviews": [
    ]
}

Check Mentor Chat Access

Check user's access to mentor-chat based on upsell

header Parameters
X-Zmrn-User-Id (integer) or X-Zmrn-User-Id (null) (X-Zmrn-User-Id)

Responses

Response samples

Content type
application/json
{
  • "has_access": true
}

change_email

users_change_email_create

Responses

users_change_email_verify_create

Responses

check_email

users_check_email_create

Responses

check_username

users_check_username_create

API ednpoint - check if username is available

Responses

create

users_create_create

API endpoint - Create user without password

Request Body schema:
required
id
integer
uid
string <uuid>
email
required
string <email>
verification_email
string or null <email> (Verification email address)
date_joined
string <date-time>
username
string or null
is_active
boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

LanguageEnum (string) or BlankEnum (any)

Responses

Request samples

Content type
{
  • "id": 0,
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "email": "user@example.com",
  • "verification_email": "user@example.com",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "is_active": true,
  • "language": "en"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "email": "user@example.com",
  • "verification_email": "user@example.com",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "is_active": true,
  • "is_new_user": "string",
  • "language": "en"
}

exists

Check if user exists

Request Body schema:
required
user_id
required
integer
email
required
string <email>

Responses

Request samples

Content type
{
  • "user_id": 0,
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "exists": true
}

health

users_health_retrieve

Health check endpoint to verify the service is running.

Responses

internal

users_internal_attribute_partial_update

Responses

users_internal_erasure_partial_update

path Parameters
user_id
required
integer

Responses

users_internal_userbyanyemail_retrieve

Responses

users_internal_users_list

query Parameters
page
integer

A page number within the paginated result set.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

users_internal_users_retrieve

path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "email": "user@example.com",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "last_login": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "verification_email": "user@example.com",
  • "is_onboarded": true,
  • "is_grace_subscription": true,
  • "language": "en",
  • "registered_at": "2019-08-24T14:15:22Z"
}

users_internal_users_email_retrieve

path Parameters
verification_email
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "email": "user@example.com",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "last_login": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "verification_email": "user@example.com",
  • "is_onboarded": true,
  • "is_grace_subscription": true,
  • "language": "en",
  • "registered_at": "2019-08-24T14:15:22Z"
}

onboard

users_onboard_create

path Parameters
user_id
required
integer

Responses

preferences

users_preferences_retrieve

path Parameters
user_id
required
integer

Responses

users_preferences_create

path Parameters
user_id
required
integer

Responses

register

users_register_create

API endpoint for user registration

Request Body schema:
required
email
required
string <email>
username
required
string
verification_email
string <email>

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "username": "string",
  • "verification_email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "user@example.com",
  • "username": "string",
  • "verification_email": "user@example.com"
}

session

users_session_create

path Parameters
user_id
required
integer

Responses

subscriptions

users_subscriptions_retrieve

path Parameters
user_id
required
integer

Responses

users_subscriptions_internal_retrieve

path Parameters
user_id
required
integer

Responses

users_subscriptions_list_retrieve

path Parameters
user_id
required
integer

Responses

users_subscriptions_cancel_create

Responses

users_subscriptions_extend_create

Responses

users_subscriptions_restore_create

Responses

tours

users_tours_retrieve

path Parameters
user_id
required
integer

Responses

users_tours_create

path Parameters
user_id
required
integer

Responses

user

users_user_retrieve

Responses

users

users_users_create

API endpoint that allows users to be viewed or edited.

Request Body schema:
required
uid
string or null <uuid>
email
required
string <email> (Email address) <= 254 characters
date_joined
string <date-time>
username
string or null
last_login
string or null <date-time>
is_active
boolean (Active)

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

verification_email
string or null <email> (Verification email address)
is_onboarded
boolean
is_grace_subscription
boolean
LanguageEnum (string) or BlankEnum (any)
registered_at
string or null <date-time>

Responses

Request samples

Content type
{
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "email": "user@example.com",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "last_login": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "verification_email": "user@example.com",
  • "is_onboarded": true,
  • "is_grace_subscription": true,
  • "language": "en",
  • "registered_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "email": "user@example.com",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "last_login": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "verification_email": "user@example.com",
  • "is_onboarded": true,
  • "is_grace_subscription": true,
  • "language": "en",
  • "registered_at": "2019-08-24T14:15:22Z"
}

users_users_retrieve

API endpoint that allows users to be viewed or edited.

path Parameters
id
required
integer

A unique integer value identifying this custom user.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
  • "email": "user@example.com",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "last_login": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "verification_email": "user@example.com",
  • "is_onboarded": true,
  • "is_grace_subscription": true,
  • "language": "en",
  • "registered_at": "2019-08-24T14:15:22Z"
}

users_users_partial_update

API endpoint that allows users to be viewed or edited.

path Parameters
id
required
integer

A unique integer value identifying this custom user.

Request Body schema:
is_onboarded
boolean
LanguageEnum (string) or BlankEnum (any)
username
string or null

Responses

Request samples

Content type
{
  • "is_onboarded": true,
  • "language": "en",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "is_onboarded": true,
  • "language": "en",
  • "username": "string"
}