Loading API Documentation...

  • auth
    • postAuthenticate a user and create a session
    • getGet current authentication info
    • postAuthenticate via Okta password flow
    • postAuthenticate via Okta social token
    • postBegin password reset
    • getValidate reset token
    • postConfirm password reset
    • postRegister a new account
    • postConfirm a registration token
    • postResend confirmation
    • postDestroy the active session
    • getRetrieve TFA configuration
    • getVerify TFA code
    • getGet email addresses
    • postAdd email address
    • getConfirm email change (GET)
    • postConfirm email change (POST)
    • getGenerate account login link
    • getGenerate captcha image
  • users
    • postSubmit contact form
    • putUpdate account profile
    • getGet account settings
    • delDelete account setting
    • postCreate guest address
    • getGet addresses
    • postCreate address
    • getGet phone numbers
    • postCreate phone number
    • getGet websites
    • postCreate website
    • getGet account resources
    • getGet account messages
    • postCreate account message
    • getGet account person details
    • getGet account actions
    • postCreate account action
    • getDashboard thumbnail image
    • getGet a specific address
    • putUpdate address
    • delDelete address
    • getGet a specific phone number
    • putUpdate phone number
    • delDelete phone number
    • getGet a specific website entry
    • putUpdate website entry by ID
    • delDelete website entry by ID
    • getGet account resources by type
    • postCreate account resource
    • getGet account resource by ID
    • putUpdate account resource
    • delDelete account resource
    • getGet message by ID
    • delDelete account message
    • getGet account action by ID
    • putUpdate account action by ID
    • delDelete account action by ID
    • putUpdate account settings
    • putUpdate website
    • delDelete website
    • putUpdate account action
    • delDelete account action
  • orgs
    • getList or search cities
    • getList countries
    • getList subcountry prefixes
    • getList subcountries
    • getList currencies
    • postCreate guest business organization
    • getGet business organizations
    • postCreate business organization
    • getGet portal resources
    • getGet portal settings
    • putUpdate portal settings
    • delDelete portal settings
    • getGet portal category by ID
    • postCreate portal category
    • getGet portal pages
    • postCreate portal page
    • getGet portal coupons
    • postCreate portal coupon
    • getGet portal people
    • postCreate portal person
    • getGet portal person attributes
    • postSubmit portal contact form
    • getGet portal stats
    • getGet portal URI path
    • getPublic portal person lookup
    • getGet portal token
    • getGet ReferralCandy integration status
    • getGet portal people addresses
    • getSite logo image
    • getSite logo fit image
    • getSite logo fill image
    • getSite logo min image
    • getSite logo max image
    • getSite logo 160x36 image
    • getSite logo 320x80 image
    • getSite favicon 16x16 image
    • getSite favicon 32x32 image
    • getPortal preview background image
    • getGet a specific business organization
    • putUpdate business organization
    • delDelete business organization
    • getGet portal resources by type
    • postCreate portal resource
    • putUpdate portal resource
    • delDelete portal resource
    • putUpdate portal category
    • delDelete portal category
    • getGet portal page by ID
    • putUpdate portal page
    • delDelete portal page
    • getGet portal coupon by ID
    • putUpdate portal coupon
    • delDelete portal coupon
    • putUpdate portal person
    • delDelete portal person
    • putUpdate portal person attributes
    • getGet portal resource by ID
  • campaigns
    • getGet portal campaign revisions
    • getList campaigns
    • postCreate campaign
    • getList campaign statuses
    • getList campaign raise modes
    • getGet pledge levels
    • postCreate pledge level
    • getGet pledge level shipping options
    • postCreate pledge level shipping option
    • getGet campaign Stripe account
    • getGet campaign resources
    • getGet campaign resource revisions
    • getGet campaign FAQs
    • postCreate campaign FAQ
    • getGet campaign FAQ pairs
    • getGet FAQ revisions
    • postCreate FAQ revision
    • getGet FAQ pair revisions
    • getValidate campaign video URL
    • getGet campaign verification status
    • postCreate/update campaign verification
    • getGet campaign notes
    • postCreate campaign note
    • getGet campaign stream
    • postCreate campaign stream entry
    • postNotify campaign stream subscribers
    • getGet campaign settings
    • delDelete campaign settings
    • getGet campaign setting revisions
    • delDelete campaign setting revision
    • getGet campaign groups
    • postCreate campaign group
    • getGet campaign comments
    • postCreate campaign comment
    • getGet comment actions
    • postCreate comment action
    • getGet campaign actions
    • postCreate campaign action
    • getGet campaign status check
    • getGet campaign revisions
    • postCreate campaign revision
    • postReplicate campaign
    • getGet campaign coupons
    • getCampaign home image variant
    • getCampaign explore image variant
    • getCampaign detail image variant
    • getCampaign detail large image variant
    • getCampaign profile image variant
    • getCampaign thumbnail image
    • getCampaign thumbnail large image
    • getCampaign reward image
    • getCampaign top header image
    • getCampaign progress status image
    • getCampaign thumbnail medium image
    • getCampaign thumbnail XL image
    • getCampaign large image
    • getCampaign medium image
    • getCampaign small image
    • getGet pledge level by ID
    • putUpdate pledge level by ID
    • delDelete pledge level by ID
    • getGet shipping option by ID
    • putUpdate shipping option by ID
    • delDelete shipping option by ID
    • getGet campaign resources by type
    • postCreate campaign resource by type
    • getGet campaign resource by ID
    • putUpdate campaign resource by ID
    • delDelete campaign resource by ID
    • getGet campaign resource revisions by type
    • postCreate campaign resource revision by type
    • putUpdate campaign resource revision by ID
    • getGet FAQ by ID
    • putUpdate FAQ by ID
    • delDelete FAQ by ID
    • getGet FAQ pair by ID
    • putUpdate FAQ pair by ID
    • delDelete FAQ pair by ID
    • getGet FAQ revision by ID
    • putUpdate FAQ revision by ID
    • delDelete FAQ revision by ID
    • getGet FAQ pair revision by ID
    • putUpdate FAQ pair revision by ID
    • delDelete FAQ pair revision by ID
    • getGet campaign note by ID
    • putUpdate campaign note by ID
    • delDelete campaign note by ID
    • getGet campaign stream entry by ID
    • putUpdate campaign stream entry by ID
    • delDelete campaign stream entry by ID
    • getGet comment by ID
    • putUpdate comment by ID
    • delDelete comment by ID
    • getGet comment action by ID
    • putUpdate comment action by ID
    • delDelete comment action by ID
    • getGet campaign action by ID
    • putUpdate campaign action by ID
    • delDelete campaign action by ID
    • getGet campaign revision by ID
    • putUpdate campaign revision by ID
    • delDelete campaign revision by ID
    • getGet campaign group by ID
    • putUpdate campaign group
    • delDelete campaign group
    • putUpdate campaign
    • delDelete campaign
    • putUpdate pledge level
    • delDelete pledge level
    • putUpdate pledge level shipping option
    • delDelete pledge level shipping option
    • postCreate campaign resource
    • putUpdate campaign resource
    • delDelete campaign resource
    • postCreate campaign resource revision
    • putUpdate campaign resource revision
    • delDelete campaign resource revision by ID
    • putUpdate campaign FAQ
    • delDelete campaign FAQ
    • putUpdate campaign FAQ pair
    • delDelete campaign FAQ pair
    • putUpdate FAQ revision
    • delDelete FAQ revision
    • putUpdate FAQ pair revision
    • delDelete FAQ pair revision
    • putUpdate campaign note
    • delDelete campaign note
    • putUpdate campaign stream entry
    • delDelete campaign stream entry
    • putUpdate campaign comment
    • delDelete campaign comment
    • putUpdate comment action
    • delDelete comment action
    • putUpdate campaign action
    • delDelete campaign action
    • putUpdate campaign revision
    • delDelete campaign revision
    • postCreate campaign FAQ pair
    • postCreate FAQ pair revision
    • getGet campaign stats
    • putUpdate campaign settings
    • getGet campaign setting by key
    • putUpdate campaign setting revision
    • getGet campaign setting revision by key
    • getGet campaign widget
    • getGet campaign resource revision by ID
  • donations
    • postCreate manual pledge
    • postCreate guest pledge
    • getGet pledges
    • postCreate pledge
    • getGet campaign backers
    • getGet pledge transactions
    • getPledge history image
    • getGet pledge by ID
    • putUpdate pledge by ID
    • delDelete pledge by ID
    • getGet pledge transaction by ID
    • putUpdate pledge transaction by ID
    • putUpdate pledge
    • delDelete pledge
    • putUpdate pledge transaction
  • payments
    • postCreate a subscription
    • postCreate guest Stripe account
    • postCreate Stripe account
    • getGet Stripe application
    • postCreate Stripe application
    • postCreate Stripe connect
    • getCheck if admin is connected to Stripe
    • getGet Stripe connect event
    • getGet Stripe account card(s)
    • postCreate Stripe account card
    • getList Stripe countries
    • getList Stripe currencies
    • getCheck Stripe link status
    • getCalculate charge amount
    • postCreate direct payment intent
    • postConfirm direct payment intent
    • postCreate Stripe Express account
    • postCreate Stripe Express onboarding link
    • getVerify connected Stripe account
    • getGet PayPal application
    • postCreate PayPal application
    • getList PayPal countries
    • getList PayPal currencies
    • postCreate guest WidgetMakr account
    • postCreate WidgetMakr account
    • getGet WidgetMakr widgets
    • postCreate WidgetMakr widget
    • getGet campaign Stripe account
    • getGet pledge transactions
    • putUpdate campaign account card
    • getGet Stripe account card by ID
    • putUpdate Stripe account card
    • delDelete Stripe account card
    • getGet WidgetMakr widget by ID
    • putUpdate WidgetMakr widget by ID
    • delDelete WidgetMakr widget by ID
    • getGet pledge transaction by ID
    • putUpdate pledge transaction by ID
    • postDetermine credit card type
    • postDetermine credit card type for account
    • getGet Stripe account data
    • putUpdate Stripe account
    • delDelete Stripe account
    • putUpdate Stripe application
    • getGet Stripe connect data
    • putUpdate Stripe connect
    • delDelete Stripe connect
    • putUpdate PayPal application
    • getGet WidgetMakr account
    • delDelete WidgetMakr account
    • putUpdate WidgetMakr widget
    • delDelete WidgetMakr widget
    • putUpdate pledge transaction
  • webhooks
    • getGet portal webhook fingerprint
    • putUpdate portal webhook fingerprint
  • admin
    • putDisable inline person
    • getCheck if admin is connected to Stripe
    • getGet portal resources
    • getGet portal settings
    • putUpdate portal settings
    • delDelete portal settings
    • getGet portal category by ID
    • postCreate portal category
    • getGet portal pages
    • postCreate portal page
    • getGet portal coupons
    • postCreate portal coupon
    • getGet portal people
    • postCreate portal person
    • getGet portal person attributes
    • getGet portal stats
    • getGet portal URI path
    • getGet portal campaign revisions
    • getGenerate account login link
    • getGet portal people addresses
    • postReplicate campaign
    • getGet portal resources by type
    • postCreate portal resource
    • putUpdate portal resource
    • delDelete portal resource
    • putUpdate portal category
    • delDelete portal category
    • getGet portal page by ID
    • putUpdate portal page
    • delDelete portal page
    • getGet portal coupon by ID
    • putUpdate portal coupon
    • delDelete portal coupon
    • putUpdate portal person
    • delDelete portal person
    • putUpdate portal person attributes
    • getGet portal resource by ID

API docs by Redocly](https://redocly.com/redoc/)

Thrinacia REST API (1.0)

Download OpenAPI specification: Download

OpenAPI 3.1 specification generated from the main controllers. Base path: /service/restv1 for JSON/form endpoints. Notes:

  • Many endpoints accept either JSON bodies or form-encoded bodies. This spec lists both.
  • When validation is ambiguous, request schemas are permissive and flagged in descriptions.

tag/auth auth

tag/auth/paths/1service1restv1~1authenticate/post Authenticate a user and create a session

Validates email/password and returns person data with auth_token. If TFA is enabled, may return valid_tfa_code_required. Turnstile token may be required when enabled.

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
email
required
string
password
required
string
code string
password_scheme string
password_scheme_options string
turnstile_token string

Responses

200

Authenticated session

400

Invalid request

401

Unauthorized

500

Internal server error

post/service/restv1/authenticate

https://www.thrinacia.com/service/restv1/authenticate

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"email": "user@example.com",

"password": "secret",

"code": "123456",

"turnstile_token": "cf-turnstile-token"

}`

Response samples

  • 200
  • 400
  • 401
  • 500

Content type

application/json

Copy

`{"person_id": 123,

"email": "user@example.com",

"first_name": "Jane",

"last_name": "Doe",

"auth_token": "sessionid"

}`

tag/auth/paths/1service1restv1~1authenticate/get Get current authentication info

Returns current session's authenticated person, if any.

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileAuthenticateRetrieveRequest)

Responses

200

Current authenticated session

400

Invalid request

401

Unauthorized

500

Internal server error

get/service/restv1/authenticate

https://www.thrinacia.com/service/restv1/authenticate

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200
  • 400
  • 401
  • 500

Content type

application/json

Copy

`{"person_id": 0,

"email": "user@example.com",

"first_name": "string",

"last_name": "string"

}`

tag/auth/paths/1service1restv11authenticate1okta/post Authenticate via Okta password flow

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
email
required
string
password
required
string

Responses

200

Authenticated session with Okta response metadata

400

Invalid request

500

Internal server error

post/service/restv1/authenticate/okta

https://www.thrinacia.com/service/restv1/authenticate/okta

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"email": "user@example.com",

"password": "string"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy Expand all Collapse all

`{"person_id": 0,

"email": "user@example.com",

"first_name": "string",

"last_name": "string",

"auth_token": "string",

"valid_tfa_code_required": false,

"okta_response": { },

"okta_id_token": "string",

"user_exists": 0,

"result_create_account": 0,

"result": "string"

}`

tag/auth/paths/1service1restv11authenticate1okta~1social/post Authenticate via Okta social token

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
id_token
required
string

Responses

200

Authenticated session with Okta token details

400

Invalid request

500

Internal server error

post/service/restv1/authenticate/okta/social

https://www.thrinacia.com/service/restv1/authenticate/okta/social

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"id_token": "string"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy Expand all Collapse all

`{"person_id": 0,

"email": "user@example.com",

"first_name": "string",

"last_name": "string",

"auth_token": "string",

"valid_tfa_code_required": false,

"okta_response": { },

"okta_id_token": "string",

"user_exists": 0,

"result_create_account": 0,

"result": "string"

}`

tag/auth/paths/1service1restv11authenticate1forgot/post Begin password reset

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
email
required
string

Responses

200

Reset request created

400

Invalid request

500

Internal server error

post/service/restv1/authenticate/forgot

https://www.thrinacia.com/service/restv1/authenticate/forgot

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"email": "user@example.com"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy

`{"success": true

}`

tag/auth/paths/1service1restv11authenticate1forgot/get Validate reset token

query Parameters
token
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
token
required
string

Responses

200

Token validation result

400

Invalid request

500

Internal server error

get/service/restv1/authenticate/forgot

https://www.thrinacia.com/service/restv1/authenticate/forgot

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"token": "string"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy

`{"validated": false

}`

tag/auth/paths/1service1restv11authenticate1forgot~1confirm/post Confirm password reset

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
token
required
string
password
required
string
password_confirm
required
string

Responses

200

Password updated

400

Invalid request

500

Internal server error

post/service/restv1/authenticate/forgot/confirm

https://www.thrinacia.com/service/restv1/authenticate/forgot/confirm

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"token": "string",

"password": "string",

"password_confirm": "string"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy

`{"id": "string",

"token_id": 1,

"token_type_id": 1,

"person_id": 1,

"value": "string",

"used": "string",

"expires": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/auth/paths/1service1restv1~1register/post Register a new account

Turnstile token may be required when enabled.

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
first_name
required
string
last_name
required
string
email
required
string
password
required
string
password_confirm
required
string
inline_registration string
use_widgetmakr string
attributes string
express_checkout string
turnstile_token string

Responses

200

Registration result

400

Invalid request

409

Conflict

500

Internal server error

post/service/restv1/register

https://www.thrinacia.com/service/restv1/register

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"first_name": "string",

"last_name": "string",

"email": "user@example.com",

"password": "string",

"password_confirm": "string",

"inline_registration": "string",

"use_widgetmakr": "string",

"attributes": "string",

"express_checkout": "string",

"turnstile_token": "string"

}`

Response samples

  • 200
  • 400
  • 409
  • 500

Content type

application/json

Copy

`{"person_id": 123,

"token": null

}`

tag/auth/paths/1service1restv11register1confirm/post Confirm a registration token

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
token
required
string

Responses

200

Confirmation result

400

Invalid request

500

Internal server error

post/service/restv1/register/confirm

https://www.thrinacia.com/service/restv1/register/confirm

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"token": "string"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy

`{"id": "token",

"activated": 1,

"email": "user@example.com"

}`

tag/auth/paths/1service1restv11register1reconfirm/post Resend confirmation

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
email
required
string

Responses

200

Reconfirm result

400

Invalid request

500

Internal server error

post/service/restv1/register/reconfirm

https://www.thrinacia.com/service/restv1/register/reconfirm

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"email": "user@example.com"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy

`{"success": true

}`

tag/auth/paths/1service1restv1~1logout/post Destroy the active session

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileLogoutRequest)

Responses

200

Logout result

400

Invalid request

post/service/restv1/logout

https://www.thrinacia.com/service/restv1/logout

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200
  • 400

Content type

application/json

Copy

`{"success": false

}`

tag/auth/paths/1service1restv11account1tfa/get Retrieve TFA configuration

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfilePersonTfaGenerateRequest)

Responses

200

TFA configuration

get/service/restv1/account/tfa

https://www.thrinacia.com/service/restv1/account/tfa

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"enabled": true,

"qr_code_url": "string",

"recovery_codes": "string",

"secret": "string"

}`

tag/auth/paths/1service1restv11account1tfa~1verify/get Verify TFA code

Authorizations:

ApiTokenAuth__SessionCookie

query Parameters
code string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfilePersonTfaVerifyRequest)

Responses

200

TFA verification result

get/service/restv1/account/tfa/verify

https://www.thrinacia.com/service/restv1/account/tfa/verify

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"valid": "string"

}`

tag/auth/paths/1service1restv11account1email/get Get email addresses

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
email
required
string

Responses

200

Email list

get/service/restv1/account/email

https://www.thrinacia.com/service/restv1/account/email

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"email": "user@example.com"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "person_id": 1,\ \ "first_name": "string",\ \ "last_name": "string",\ \ "email": "user@example.com",\ \ "bio": "string"\ \ }\ \ ]

tag/auth/paths/1service1restv11account1email/post Add email address

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileAccountSubmitEmailRequest)

Responses

200

Email created

post/service/restv1/account/email

https://www.thrinacia.com/service/restv1/account/email

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"success": true

}`

tag/auth/paths/1service1restv11account1email~1confirm/get Confirm email change (GET)

Authorizations:

ApiTokenAuth__SessionCookie

query Parameters
token string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
token
required
string

Responses

200

Confirmation result

get/service/restv1/account/email/confirm

https://www.thrinacia.com/service/restv1/account/email/confirm

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"validated": "string"

}`

tag/auth/paths/1service1restv11account1email~1confirm/post Confirm email change (POST)

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
token
required
string
email
required
string

Responses

200

Confirmation result

post/service/restv1/account/email/confirm

https://www.thrinacia.com/service/restv1/account/email/confirm

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"token": "string",

"email": "user@example.com"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"token_id": 1,

"token_type_id": 1,

"person_id": 1,

"value": "string",

"used": "string",

"expires": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/auth/paths/1service1restv11portal1account-login-link/get Generate account login link

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id string

Responses

200

Login link

get/service/restv1/portal/account-login-link

https://www.thrinacia.com/service/restv1/portal/account-login-link

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/auth/paths/~1captcha/get Generate captcha image

Responses

200

Captcha image

get/captcha

https://www.thrinacia.com/captcha

Response samples

  • 200

Content type

image/*

Copy

string

tag/users users

tag/users/paths/1service1restv1~1contact/post Submit contact form

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
name
required
string
description
required
string
email
required
string
phone string
business_organization string
source string
website string

Responses

200

Contact form submission result

400

Invalid request

500

Internal server error

post/service/restv1/contact

https://www.thrinacia.com/service/restv1/contact

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"description": "string",

"email": "user@example.com",

"phone": "string",

"business_organization": "string",

"source": "string",

"website": "string"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy

`{"success": false

}`

tag/users/paths/1service1restv1~1account/put Update account profile

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
first_name string
last_name string
bio string
password_old string
password string
password_confirm string

Responses

200

Updated account

400

Invalid request

401

Unauthorized

put/service/restv1/account

https://www.thrinacia.com/service/restv1/account

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"first_name": "string",

"last_name": "string",

"bio": "string",

"password_old": "string",

"password": "string",

"password_confirm": "string"

}`

Response samples

  • 200
  • 400
  • 401

Content type

application/json

Copy

`{"password": "string"

}`

tag/users/paths/1service1restv11account1setting/get Get account settings

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
setting string

Responses

200

Settings

get/service/restv1/account/setting

https://www.thrinacia.com/service/restv1/account/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"setting": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/users/paths/1service1restv11account1setting/delete Delete account setting

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
public string

Responses

200

Deleted

delete/service/restv1/account/setting

https://www.thrinacia.com/service/restv1/account/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"public": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"success": true

}`

tag/users/paths/1service1restv11account1address~1guest/post Create guest address

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
city_id
required
integer
city_alt string
mail_code string
street1
required
string
street2 string
description string
primary_address string

Responses

200

Address created

post/service/restv1/account/address/guest

https://www.thrinacia.com/service/restv1/account/address/guest

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"city_id": 0,

"city_alt": "string",

"mail_code": "string",

"street1": "string",

"street2": "string",

"description": "string",

"primary_address": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"address_type": "string",

"address_id": 1,

"address_type_id": 1,

"city_id": 1,

"city_alt": "string",

"mail_code": "string",

"street1": "string",

"street2": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_id": 1,

"country": "string",

"code_iso3166_1": "string",

"subcountry_id": 1,

"primary_address_person": "string",

"primary_address_business_organization": "string",

"country_native_name": "string",

"subcountry_native_name": "string",

"city_native_name": "string"

}`

tag/users/paths/1service1restv11account1address/get Get addresses

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
business_organization_id integer
address_id integer
inline_token string

Responses

200

Address list

get/service/restv1/account/address

https://www.thrinacia.com/service/restv1/account/address

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"business_organization_id": 0,

"address_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"business": [ ]\ \ }\ \ ]

tag/users/paths/1service1restv11account1address/post Create address

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
person_id integer
city_id
required
integer
city_alt string
mail_code string
street1
required
string
street2 string
description string
primary_address string
inline_token string

Responses

200

Address created

post/service/restv1/account/address

https://www.thrinacia.com/service/restv1/account/address

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"person_id": 0,

"city_id": 0,

"city_alt": "string",

"mail_code": "string",

"street1": "string",

"street2": "string",

"description": "string",

"primary_address": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"address_type": "string",

"address_id": 1,

"address_type_id": 1,

"city_id": 1,

"city_alt": "string",

"mail_code": "string",

"street1": "string",

"street2": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_id": 1,

"country": "string",

"code_iso3166_1": "string",

"subcountry_id": 1,

"primary_address_person": "string",

"primary_address_business_organization": "string",

"country_native_name": "string",

"subcountry_native_name": "string",

"city_native_name": "string"

}`

tag/users/paths/1service1restv11account1phone-number/get Get phone numbers

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
business_organization_id integer
phone_number_id integer
inline_token string

Responses

200

Phone list

get/service/restv1/account/phone-number

https://www.thrinacia.com/service/restv1/account/phone-number

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"business_organization_id": 0,

"phone_number_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"business": [ ]\ \ }\ \ ]

tag/users/paths/1service1restv11account1phone-number/post Create phone number

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
person_id integer
phone_number_type_id integer
number
required
string
primary_phone_number string
description string
inline_token string

Responses

200

Phone created

post/service/restv1/account/phone-number

https://www.thrinacia.com/service/restv1/account/phone-number

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"person_id": 0,

"phone_number_type_id": 0,

"number": "string",

"primary_phone_number": "string",

"description": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"phone_number_id": 1,

"phone_number_type_id": 1,

"number": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/users/paths/1service1restv11account1website/get Get websites

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
uri_id integer
business_organization_id integer
person_id integer

Responses

200

Website list

get/service/restv1/account/website

https://www.thrinacia.com/service/restv1/account/website

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"uri_id": 0,

"business_organization_id": 0,

"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/users/paths/1service1restv11account1website/post Create website

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
uri string
uri_text string
person_id integer

Responses

200

Website created

post/service/restv1/account/website

https://www.thrinacia.com/service/restv1/account/website

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"uri": "string",

"uri_text": "string",

"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"uri_id": 1,

"uri": "https://example.com",

"uri_text": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/users/paths/1service1restv11account1resource/get Get account resources

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource list

get/service/restv1/account/resource

https://www.thrinacia.com/service/restv1/account/resource

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"personal": [{"id": 1,

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": false,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "file",

"person_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}

],

"business": [{"id": 1,

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": false,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "file",

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"business_organization_file_id": 1

}

]

}`

tag/users/paths/1service1restv11account1message/get Get account messages

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
message_id string
filters string

Responses

200

Message list

get/service/restv1/account/message

https://www.thrinacia.com/service/restv1/account/message

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"message_id": "string",

"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "message_id": 1,\ \ "subject": "string",\ \ "body": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "person_id": 1,\ \ "message_person_type_id": 1,\ \ "message_type": "string",\ \ "person_id_sender": "string",\ \ "person_first_name_sender": "string",\ \ "person_last_name_sender": "string",\ \ "person_id_receiver": "string",\ \ "person_first_name_receiver": "string",\ \ "person_last_name_receiver": "string"\ \ }\ \ ]

tag/users/paths/1service1restv11account1message/post Create account message

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id
required
string
subject
required
string
body
required
string
first_name string
last_name string
email string

Responses

200

Message created

post/service/restv1/account/message

https://www.thrinacia.com/service/restv1/account/message

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": "string",

"subject": "string",

"body": "string",

"first_name": "string",

"last_name": "string",

"email": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"message_id": 1,

"subject": "string",

"body": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"message_person_type_id": 1,

"message_type": "string",

"person_id_sender": "string",

"person_first_name_sender": "string",

"person_last_name_sender": "string",

"person_id_receiver": "string",

"person_first_name_receiver": "string",

"person_last_name_receiver": "string"

}`

tag/users/paths/1service1restv11account1person/get Get account person details

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id
required
integer

Responses

200

Person data

get/service/restv1/account/person

https://www.thrinacia.com/service/restv1/account/person

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"person_id": 0,

"email": "user@example.com",

"first_name": "string",

"last_name": "string"

}`

tag/users/paths/1service1restv11account1action/get Get account actions

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_action_id integer
filters string

Responses

200

Action list

get/service/restv1/account/action

https://www.thrinacia.com/service/restv1/account/action

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_action_id": 0,

"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "person_action_id": 1,\ \ "person_action_type_id": 1,\ \ "person_id_source": "string",\ \ "person_id_target": "string",\ \ "anonymous": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "person_action_type": "string",\ \ "person_action_person_source": [ ],\ \ "person_action_person_target": [ ]\ \ }\ \ ]

tag/users/paths/1service1restv11account1action/post Create account action

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_action_type_id
required
integer
person_id_source integer
person_id_target
required
integer
anonymous string

Responses

200

Action created

post/service/restv1/account/action

https://www.thrinacia.com/service/restv1/account/action

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_action_type_id": 0,

"person_id_source": 0,

"person_id_target": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"person_action_id": 1,

"person_action_type_id": 1,

"person_id_source": "string",

"person_id_target": "string",

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_action_type": "string",

"person_action_person_source": [ ],

"person_action_person_target": [ ]

}`

tag/users/paths/1image1want_dashboard_thumbnail/get Dashboard thumbnail image

Responses

200

Image

get/image/want_dashboard_thumbnail

https://www.thrinacia.com/image/want\_dashboard\_thumbnail

Response samples

  • 200

Content type

image/*

Copy

string

tag/users/paths/1service1restv11account1address~1{address_id}/get Get a specific address

path Parameters
address_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
business_organization_id integer
address_id integer
inline_token string

Responses

200

Address

get/service/restv1/account/address/{address_id}

https://www.thrinacia.com/service/restv1/account/address/{address\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"business_organization_id": 0,

"address_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"business": [ ]\ \ }\ \ ]

tag/users/paths/1service1restv11account1address~1{address_id}/put Update address

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
address_id
required
integer
person_id integer
business_organization_id integer
city_id integer
city_alt string
mail_code string
street1 string
street2 string
description string
primary_address string
inline_token string

Responses

200

Address updated

put/service/restv1/account/address/{address_id}

https://www.thrinacia.com/service/restv1/account/address/{address\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"address_id": 0,

"person_id": 0,

"business_organization_id": 0,

"city_id": 0,

"city_alt": "string",

"mail_code": "string",

"street1": "string",

"street2": "string",

"description": "string",

"primary_address": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"address_type": "string",

"address_id": 1,

"address_type_id": 1,

"city_id": 1,

"city_alt": "string",

"mail_code": "string",

"street1": "string",

"street2": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_id": 1,

"country": "string",

"code_iso3166_1": "string",

"subcountry_id": 1,

"primary_address_person": "string",

"primary_address_business_organization": "string",

"country_native_name": "string",

"subcountry_native_name": "string",

"city_native_name": "string"

}`

tag/users/paths/1service1restv11account1address~1{address_id}/delete Delete address

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
person_id integer
address_id
required
integer
inline_token string

Responses

200

Address deleted

delete/service/restv1/account/address/{address_id}

https://www.thrinacia.com/service/restv1/account/address/{address\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"person_id": 0,

"address_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"address_type": "string",

"address_id": 1,

"address_type_id": 1,

"city_id": 1,

"city_alt": "string",

"mail_code": "string",

"street1": "string",

"street2": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_id": 1,

"country": "string",

"code_iso3166_1": "string",

"subcountry_id": 1,

"primary_address_person": "string",

"primary_address_business_organization": "string",

"country_native_name": "string",

"subcountry_native_name": "string",

"city_native_name": "string"

}`

tag/users/paths/1service1restv11account1phone-number~1{phone_number_id}/get Get a specific phone number

path Parameters
phone_number_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
business_organization_id integer
phone_number_id integer
inline_token string

Responses

200

Phone number

get/service/restv1/account/phone-number/{phone_number_id}

https://www.thrinacia.com/service/restv1/account/phone-number/{phone\_number\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"business_organization_id": 0,

"phone_number_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"business": [ ]\ \ }\ \ ]

tag/users/paths/1service1restv11account1phone-number~1{phone_number_id}/put Update phone number

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
business_organization_id integer
phone_number_id integer
phone_number_type_id integer
number
required
string
primary_phone_number string
description string
inline_token string

Responses

200

Phone updated

put/service/restv1/account/phone-number/{phone_number_id}

https://www.thrinacia.com/service/restv1/account/phone-number/{phone\_number\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"business_organization_id": 0,

"phone_number_id": 0,

"phone_number_type_id": 0,

"number": "string",

"primary_phone_number": "string",

"description": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"phone_number_id": 1,

"phone_number_type_id": 1,

"number": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/users/paths/1service1restv11account1phone-number~1{phone_number_id}/delete Delete phone number

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
person_id integer
phone_number_id
required
integer
inline_token string

Responses

200

Phone deleted

delete/service/restv1/account/phone-number/{phone_number_id}

https://www.thrinacia.com/service/restv1/account/phone-number/{phone\_number\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"person_id": 0,

"phone_number_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"phone_number_id": 1,

"phone_number_type_id": 1,

"number": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/users/paths/1service1restv11account1website~1{uri_id}/get Get a specific website entry

path Parameters
uri_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
uri_id integer
business_organization_id integer
person_id integer

Responses

200

Website entry

get/service/restv1/account/website/{uri_id}

https://www.thrinacia.com/service/restv1/account/website/{uri\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"uri_id": 0,

"business_organization_id": 0,

"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"uri_id": 1,\ \ "uri": "https://example.com",\ \ "uri_text": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "business_organization_id": 1\ \ }\ \ ]

tag/users/paths/1service1restv11account1website~1{uri_id}/put Update website entry by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
uri_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
person_id integer
uri_id
required
integer
uri string
uri_text string

Responses

200

Website entry updated

put/service/restv1/account/website/{uri_id}

https://www.thrinacia.com/service/restv1/account/website/{uri\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"person_id": 0,

"uri_id": 0,

"uri": "string",

"uri_text": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"uri_id": 1,

"uri": "https://example.com",

"uri_text": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/users/paths/1service1restv11account1website~1{uri_id}/delete Delete website entry by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
uri_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
person_id integer
uri_id
required
integer

Responses

200

Website entry deleted

delete/service/restv1/account/website/{uri_id}

https://www.thrinacia.com/service/restv1/account/website/{uri\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"person_id": 0,

"uri_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"uri_id": 1,

"uri": "https://example.com",

"uri_text": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/users/paths/1service1restv11account1resource~1{resource_type}/get Get account resources by type

path Parameters
resource_type
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource list

get/service/restv1/account/resource/{resource_type}

https://www.thrinacia.com/service/restv1/account/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

}`

tag/users/paths/1service1restv11account1resource~1{resource_type}/post Create account resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required
resource_type
required
string
resource_content_type
required
string
resource
required
string
business_organization_id integer
person_id integer
region_id integer

Responses

200

Resource created

post/service/restv1/account/resource/{resource_type}

https://www.thrinacia.com/service/restv1/account/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"business_organization_file_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/users/paths/1service1restv11account1resource1{resource_type}1{resource_id}/get Get account resource by ID

path Parameters
resource_type
required
string
resource_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource

get/service/restv1/account/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/account/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"person_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/users/paths/1service1restv11account1resource1{resource_type}1{resource_id}/put Update account resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required
resource_id
required
string
resource_type
required
string
resource_content_type
required
string
resource
required
string
business_organization_id integer
person_id integer
region_id integer

Responses

200

Resource updated

put/service/restv1/account/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/account/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"business_organization_file_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/users/paths/1service1restv11account1resource1{resource_type}1{resource_id}/delete Delete account resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id
required
string
resource_type
required
string
business_organization_id integer
person_id integer

Responses

200

Resource deleted

delete/service/restv1/account/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/account/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"business_organization_file_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/users/paths/1service1restv11account1message~1{message_id}/get Get message by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
message_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
message_id string
filters string

Responses

200

Message

get/service/restv1/account/message/{message_id}

https://www.thrinacia.com/service/restv1/account/message/{message\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"message_id": "string",

"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/users/paths/1service1restv11account1message~1{message_id}/delete Delete account message

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
message_id
required
string

Responses

200

Message deleted

delete/service/restv1/account/message/{message_id}

https://www.thrinacia.com/service/restv1/account/message/{message\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"message_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"message_id": 1,

"subject": "string",

"body": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"message_person_type_id": 1,

"message_type": "string",

"person_id_sender": "string",

"person_first_name_sender": "string",

"person_last_name_sender": "string",

"person_id_receiver": "string",

"person_first_name_receiver": "string",

"person_last_name_receiver": "string"

}`

tag/users/paths/1service1restv11account1action~1{person_action_id}/get Get account action by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
person_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_action_id integer
filters string

Responses

200

Action

get/service/restv1/account/action/{person_action_id}

https://www.thrinacia.com/service/restv1/account/action/{person\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_action_id": 0,

"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/users/paths/1service1restv11account1action~1{person_action_id}/put Update account action by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
person_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_action_id
required
integer
person_action_type_id integer
person_id_source integer
person_id_target integer
anonymous string

Responses

200

Action updated

put/service/restv1/account/action/{person_action_id}

https://www.thrinacia.com/service/restv1/account/action/{person\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_action_id": 0,

"person_action_type_id": 0,

"person_id_source": 0,

"person_id_target": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"person_action_id": 1,

"person_action_type_id": 1,

"person_id_source": "string",

"person_id_target": "string",

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_action_type": "string",

"person_action_person_source": [ ],

"person_action_person_target": [ ]

}`

tag/users/paths/1service1restv11account1action~1{person_action_id}/delete Delete account action by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
person_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_action_id
required
integer
person_id_source integer

Responses

200

Action deleted

delete/service/restv1/account/action/{person_action_id}

https://www.thrinacia.com/service/restv1/account/action/{person\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_action_id": 0,

"person_id_source": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"person_action_id": 1,

"person_action_type_id": 1,

"person_id_source": "string",

"person_id_target": "string",

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_action_type": "string",

"person_action_person_source": [ ],

"person_action_person_target": [ ]

}`

tag/users/paths/1service1restv11account1setting~1{public?}/put Update account settings

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
public string

Responses

200

Updated settings

put/service/restv1/account/setting/{public?}

https://www.thrinacia.com/service/restv1/account/setting/{public?}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"public": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"setting_id": 1,

"setting_type_id": 1,

"name": "string",

"value": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/users/paths/1service1restv11account1website~1{website_id}/put Update website

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
person_id integer
uri_id
required
integer
uri string
uri_text string

Responses

200

Website updated

put/service/restv1/account/website/{website_id}

https://www.thrinacia.com/service/restv1/account/website/{website\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"person_id": 0,

"uri_id": 0,

"uri": "string",

"uri_text": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"uri_id": 1,

"uri": "https://example.com",

"uri_text": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/users/paths/1service1restv11account1website~1{website_id}/delete Delete website

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id integer
person_id integer
uri_id
required
integer

Responses

200

Website deleted

delete/service/restv1/account/website/{website_id}

https://www.thrinacia.com/service/restv1/account/website/{website\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"person_id": 0,

"uri_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"uri_id": 1,

"uri": "https://example.com",

"uri_text": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/users/paths/1service1restv11account1action~1{action_id}/put Update account action

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Action updated

put/service/restv1/account/action/{action_id}

https://www.thrinacia.com/service/restv1/account/action/{action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_action_id": 0,

"person_action_type_id": 0,

"person_id_source": 0,

"person_id_target": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"person_action_id": 1,

"person_action_type_id": 1,

"person_id_source": "string",

"person_id_target": "string",

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_action_type": "string",

"person_action_person_source": [ ],

"person_action_person_target": [ ]

}`

tag/users/paths/1service1restv11account1action~1{action_id}/delete Delete account action

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_action_id
required
integer
person_id_source integer

Responses

200

Action deleted

delete/service/restv1/account/action/{action_id}

https://www.thrinacia.com/service/restv1/account/action/{action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_action_id": 0,

"person_id_source": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"person_action_id": 1,

"person_action_type_id": 1,

"person_id_source": "string",

"person_id_target": "string",

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_action_type": "string",

"person_action_person_source": [ ],

"person_action_person_target": [ ]

}`

tag/orgs orgs

tag/orgs/paths/1service1restv11locale1city/get List or search cities

Pagination headers may be returned (X-Pager-*).

query Parameters
native_lookup boolean
subcountry_id integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
city_prefix string
native_lookup string
subcountry_id string

Responses

200

City list

400

Invalid request

get/service/restv1/locale/city

https://www.thrinacia.com/service/restv1/locale/city

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"city_prefix": "string",

"native_lookup": "string",

"subcountry_id": "string"

}`

Response samples

  • 200
  • 400

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "city_id": 1,\ \ "name": "string",\ \ "native_name": "string",\ \ "country": "string",\ \ "country_id": 1,\ \ "country_code_iso3166_1": "string",\ \ "subcountry": "string",\ \ "subcountry_id": 1,\ \ "city": "string",\ \ "country_native_name": "string",\ \ "subcountry_native_name": "string",\ \ "city_native_name": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11locale1country/get List countries

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileLocaleCountryRetrieveRequest)

Responses

200

Country list

400

Invalid request

get/service/restv1/locale/country

https://www.thrinacia.com/service/restv1/locale/country

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200
  • 400

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11locale1subcountry-prefix/get List subcountry prefixes

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
subcountry_prefix
required
string
native_lookup string

Responses

200

Subcountry prefix list

get/service/restv1/locale/subcountry-prefix

https://www.thrinacia.com/service/restv1/locale/subcountry-prefix

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"subcountry_prefix": "string",

"native_lookup": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "subcountry_id": 1,\ \ "subcountry_type_id": 1,\ \ "country_id": 1,\ \ "name": "string",\ \ "native_name": "string",\ \ "code_iso3166_2": "string",\ \ "code_fips_10_4": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z"\ \ }\ \ ]

tag/orgs/paths/1service1restv11locale1subcountry/get List subcountries

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
country_id
required
string

Responses

200

Subcountry list

get/service/restv1/locale/subcountry

https://www.thrinacia.com/service/restv1/locale/subcountry

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"country_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11locale1currency/get List currencies

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileLocaleCurrencyRetrieveRequest)

Responses

200

Currency list

get/service/restv1/locale/currency

https://www.thrinacia.com/service/restv1/locale/currency

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11account1business~1guest/post Create guest business organization

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
name
required
string
description string

Responses

200

Business created

post/service/restv1/account/business/guest

https://www.thrinacia.com/service/restv1/account/business/guest

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"business_organization_id": 1,

"name": "string",

"email": "user@example.com",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/orgs/paths/1service1restv11account1business/get Get business organizations

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
business_organization_id integer
inline_token string

Responses

200

Business list

get/service/restv1/account/business

https://www.thrinacia.com/service/restv1/account/business

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"business_organization_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11account1business/post Create business organization

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
name
required
string
email string
description string
inline_token string

Responses

200

Business created

post/service/restv1/account/business

https://www.thrinacia.com/service/restv1/account/business

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"name": "string",

"email": "string",

"description": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"business_organization_id": 1,

"name": "string",

"email": "user@example.com",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/orgs/paths/1service1restv11portal1resource/get Get portal resources

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource list

get/service/restv1/portal/resource

https://www.thrinacia.com/service/restv1/portal/resource

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": 1,\ \ "file_id": 1,\ \ "file_type_id": 1,\ \ "name": "string",\ \ "path_internal": "string",\ \ "path_external": "string",\ \ "disabled": false,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "resource_type": "file",\ \ "region_resource_id": 1,\ \ "resource_content_type": "string",\ \ "resource_content_type_id": 1,\ \ "file_type": "string",\ \ "description": "string",\ \ "mime_type": "string",\ \ "extension": "string",\ \ "category_id": 1,\ \ "category_name": "string",\ \ "region_id": 1\ \ }\ \ ]

tag/orgs/paths/1service1restv11portal1setting/get Get portal settings

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
setting string

Responses

200

Settings list

get/service/restv1/portal/setting

https://www.thrinacia.com/service/restv1/portal/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"setting": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11portal1setting/put Update portal settings

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
public string

Responses

200

Settings updated

put/service/restv1/portal/setting

https://www.thrinacia.com/service/restv1/portal/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"public": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"setting_id": 1

}`

tag/orgs/paths/1service1restv11portal1setting/delete Delete portal settings

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
public string

Responses

200

Settings deleted

delete/service/restv1/portal/setting

https://www.thrinacia.com/service/restv1/portal/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"public": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"setting_id": 1

}`

tag/orgs/paths/1service1restv11portal1category/get Get portal category by ID

path Parameters
category_id
required
integer

Responses

200

Category

get/service/restv1/portal/category

https://www.thrinacia.com/service/restv1/portal/category

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"category_id": 1,

"parent_category_id": 1,

"name": "string",

"description": "string",

"icon": "string",

"display_priority": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"subcategories": [ ],

"uri_paths": [ ]

}`

tag/orgs/paths/1service1restv11portal1category/post Create portal category

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
name
required
string
description string
parent_category_id integer
display_priority string
attributes string
uri_path string

Responses

200

Category created

post/service/restv1/portal/category

https://www.thrinacia.com/service/restv1/portal/category

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"description": "string",

"parent_category_id": 0,

"display_priority": "string",

"attributes": "string",

"uri_path": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"category_id": 1,

"parent_category_id": 1,

"name": "string",

"description": "string",

"icon": "string",

"display_priority": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"subcategories": [ ],

"uri_paths": [ ]

}`

tag/orgs/paths/1service1restv11portal1page/get Get portal pages

query Parameters
page_id integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
page_id integer

Responses

200

Page list or single page

get/service/restv1/portal/page

https://www.thrinacia.com/service/restv1/portal/page

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"page_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "page_id": 1,\ \ "uri_path_id": 1,\ \ "name": "string",\ \ "title": "string",\ \ "content": "string",\ \ "meta": "string",\ \ "display_priority": "string",\ \ "published": "string",\ \ "reserved": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "path": "string",\ \ "path_text": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11portal1page/post Create portal page

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
name
required
string
title string
content string
path string
path_text string
meta string
display_priority string
published string

Responses

200

Page created

post/service/restv1/portal/page

https://www.thrinacia.com/service/restv1/portal/page

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"title": "string",

"content": "string",

"path": "string",

"path_text": "string",

"meta": "string",

"display_priority": "string",

"published": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"page_id": 1,

"uri_path_id": 1,

"name": "string",

"title": "string",

"content": "string",

"meta": "string",

"display_priority": "string",

"published": "string",

"reserved": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"path": "string",

"path_text": "string"

}`

tag/orgs/paths/1service1restv11portal1coupon/get Get portal coupons

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
coupon_id integer

Responses

200

Coupon list

get/service/restv1/portal/coupon

https://www.thrinacia.com/service/restv1/portal/coupon

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "coupon_id": 1,\ \ "code": "string",\ \ "name": "string",\ \ "description": "string",\ \ "discount_amount": 10,\ \ "discount_percentage": "string",\ \ "expires_date_time": "string",\ \ "expires_quantity": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z"\ \ }\ \ ]

tag/orgs/paths/1service1restv11portal1coupon/post Create portal coupon

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
code
required
string
name
required
string
description string
discount_amount number
discount_percentage number
expires_date_time string
expires_quantity integer

Responses

200

Coupon created

post/service/restv1/portal/coupon

https://www.thrinacia.com/service/restv1/portal/coupon

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"code": "string",

"name": "string",

"description": "string",

"discount_amount": 0,

"discount_percentage": 0,

"expires_date_time": "2019-08-24T14:15:22Z",

"expires_quantity": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"coupon_id": 1,

"code": "string",

"name": "string",

"description": "string",

"discount_amount": 10,

"discount_percentage": "string",

"expires_date_time": "string",

"expires_quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/orgs/paths/1service1restv11portal1person/get Get portal people

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
filters string

Responses

200

People list

get/service/restv1/portal/person

https://www.thrinacia.com/service/restv1/portal/person

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"person_id": 1,\ \ "person_type_id": 1,\ \ "person_status_id": 1,\ \ "first_name": "string",\ \ "last_name": "string",\ \ "email": "user@example.com",\ \ "id": "string",\ \ "bio": "string",\ \ "attributes": "string",\ \ "campaign_manager": true,\ \ "campaign_backer": true,\ \ "portal_admin": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true,\ \ "websites": [ ],\ \ "files": [ ],\ \ "widgetmakr_cmdi": [ ]\ \ }\ \ ]

tag/orgs/paths/1service1restv11portal1person/post Create portal person

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
first_name
required
string
last_name
required
string
bio string
person_status_id string
person_type_id string
email
required
string
password string
password_confirm string
password_scheme string
password_scheme_options string
password_passthrough string
use_widgetmakr string
pid string
tracking_number string
attributes string

Responses

200

Person created

post/service/restv1/portal/person

https://www.thrinacia.com/service/restv1/portal/person

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"first_name": "string",

"last_name": "string",

"bio": "string",

"person_status_id": "string",

"person_type_id": "string",

"email": "user@example.com",

"password": "string",

"password_confirm": "string",

"password_scheme": "string",

"password_scheme_options": "string",

"password_passthrough": "string",

"use_widgetmakr": "string",

"pid": "string",

"tracking_number": "string",

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"inline_token": "string",

"person_id": 1,

"token": "token_example"

}`

tag/orgs/paths/1service1restv11portal1person~1attribute/get Get portal person attributes

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
filters string

Responses

200

Person attributes list

get/service/restv1/portal/person/attribute

https://www.thrinacia.com/service/restv1/portal/person/attribute

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"person_id": 1,\ \ "attributes": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11portal1contact/post Submit portal contact form

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Contact submitted

post/service/restv1/portal/contact

https://www.thrinacia.com/service/restv1/portal/contact

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"description": "string",

"email": "user@example.com",

"phone": "string",

"business_organization": "string",

"source": "string",

"website": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"submitted": "string"

}`

tag/orgs/paths/1service1restv11portal1stats/get Get portal stats

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
summary integer
use_widgetmakr integer

Responses

200

Stats

get/service/restv1/portal/stats

https://www.thrinacia.com/service/restv1/portal/stats

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"summary": 0,

"use_widgetmakr": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"refreshed": "string",

"total_campaigns": "string",

"total_campaigns_being_edited": "string",

"total_campaigns_running": "string",

"total_campaigns_not_approved": "string",

"total_campaigns_paused": "string",

"total_campaigns_processing_pre_auth": "string",

"total_campaigns_processing_accepted_capture": "string",

"total_campaigns_processing_declined_capture": "string",

"total_campaigns_processing_processing_capture": "string",

"total_campaigns_processing_capture_complete": "string",

"total_campaigns_sent_for_review": "string",

"total_campaigns_cancelled": "string",

"total_campaigns_being_reviewed": "string",

"total_campaigns_not_funded": "string",

"total_campaigns_processing": "string",

"total_campaign_funding_sought": "string",

"total_campaign_funding_sought_running": "string",

"total_campaign_funding_sought_capture_complete": "string",

"total_campaign_funding_raised_running": "string",

"total_campaign_funding_raised_capture_complete": "string"

}`

tag/orgs/paths/1service1restv11portal1uri-path/get Get portal URI path

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
uri_path string

Responses

200

URI path

get/service/restv1/portal/uri-path

https://www.thrinacia.com/service/restv1/portal/uri-path

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"uri_path": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"result": "string"

}`

tag/orgs/paths/1service1restv11portal1person-public/get Public portal person lookup

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
filters string

Responses

200

Public person list

get/service/restv1/portal/person-public

https://www.thrinacia.com/service/restv1/portal/person-public

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"person_id": 1,\ \ "first_name": "string",\ \ "last_name": "string",\ \ "id": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11portal1token/get Get portal token

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
type string

Responses

200

Portal token

get/service/restv1/portal/token

https://www.thrinacia.com/service/restv1/portal/token

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"type": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"token": "token_example",

"type": "string"

}`

tag/orgs/paths/1service1restv11portal1integration~1referral-candy/get Get ReferralCandy integration status

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
email
required
string
first_name
required
string
invoice_amount
required
string
timestamp
required
string

Responses

200

ReferralCandy status

get/service/restv1/portal/integration/referral-candy

https://www.thrinacia.com/service/restv1/portal/integration/referral-candy

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"email": "string",

"first_name": "string",

"invoice_amount": "string",

"timestamp": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"signature": "string"

}`

tag/orgs/paths/1service1restv11portal1people/get Get portal people addresses

Authorizations:

ApiTokenAuth__SessionCookie

Responses

200

People address list

get/service/restv1/portal/people

https://www.thrinacia.com/service/restv1/portal/people

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"person_id": 1,\ \ "person_type_id": 1,\ \ "person_status_id": 1,\ \ "first_name": "string",\ \ "last_name": "string",\ \ "email": "user@example.com",\ \ "id": "string",\ \ "bio": "string",\ \ "attributes": "string",\ \ "campaign_manager": true,\ \ "campaign_backer": true,\ \ "portal_admin": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true,\ \ "websites": [ ],\ \ "files": [ ],\ \ "widgetmakr_cmdi": [ ],\ \ "addresses": [ ]\ \ }\ \ ]

tag/orgs/paths/1image1want_site_logo/get Site logo image

Responses

200

Image

get/image/want_site_logo

https://www.thrinacia.com/image/want\_site\_logo

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_site_logo_fit/get Site logo fit image

Responses

200

Image

get/image/want_site_logo_fit

https://www.thrinacia.com/image/want\_site\_logo\_fit

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_site_logo_fill/get Site logo fill image

Responses

200

Image

get/image/want_site_logo_fill

https://www.thrinacia.com/image/want\_site\_logo\_fill

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_site_logo_min/get Site logo min image

Responses

200

Image

get/image/want_site_logo_min

https://www.thrinacia.com/image/want\_site\_logo\_min

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_site_logo_max/get Site logo max image

Responses

200

Image

get/image/want_site_logo_max

https://www.thrinacia.com/image/want\_site\_logo\_max

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_site_logo_160x36/get Site logo 160x36 image

Responses

200

Image

get/image/want_site_logo_160x36

https://www.thrinacia.com/image/want\_site\_logo\_160x36

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_site_logo_320x80/get Site logo 320x80 image

Responses

200

Image

get/image/want_site_logo_320x80

https://www.thrinacia.com/image/want\_site\_logo\_320x80

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_site_favicon_16x16/get Site favicon 16x16 image

Responses

200

Image

get/image/want_site_favicon_16x16

https://www.thrinacia.com/image/want\_site\_favicon\_16x16

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_site_favicon_32x32/get Site favicon 32x32 image

Responses

200

Image

get/image/want_site_favicon_32x32

https://www.thrinacia.com/image/want\_site\_favicon\_32x32

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1image1want_portal_setting_preview_background/get Portal preview background image

Responses

200

Image

get/image/want_portal_setting_preview_background

https://www.thrinacia.com/image/want\_portal\_setting\_preview\_background

Response samples

  • 200

Content type

image/*

Copy

string

tag/orgs/paths/1service1restv11account1business~1{business_organization_id}/get Get a specific business organization

path Parameters
business_organization_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
business_organization_id integer
inline_token string

Responses

200

Business organization

get/service/restv1/account/business/{business_organization_id}

https://www.thrinacia.com/service/restv1/account/business/{business\_organization\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"business_organization_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "business_organization_id": 1,\ \ "name": "string",\ \ "email": "user@example.com",\ \ "description": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z"\ \ }\ \ ]

tag/orgs/paths/1service1restv11account1business~1{business_organization_id}/put Update business organization

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer
business_organization_id
required
integer
name string
email string
description string
inline_token string

Responses

200

Business updated

put/service/restv1/account/business/{business_organization_id}

https://www.thrinacia.com/service/restv1/account/business/{business\_organization\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"business_organization_id": 0,

"name": "string",

"email": "string",

"description": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"business_organization_id": 1,

"name": "string",

"email": "user@example.com",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/orgs/paths/1service1restv11account1business~1{business_organization_id}/delete Delete business organization

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
business_organization_id
required
integer
inline_token string

Responses

200

Business deleted

delete/service/restv1/account/business/{business_organization_id}

https://www.thrinacia.com/service/restv1/account/business/{business\_organization\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"business_organization_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"business_organization_id": 1,

"name": "string",

"email": "user@example.com",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/orgs/paths/1service1restv11portal1resource~1{resource_type}/get Get portal resources by type

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
resource_type
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource list

get/service/restv1/portal/resource/{resource_type}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/orgs/paths/1service1restv11portal1resource~1{resource_type}/post Create portal resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required

Responses

200

Resource created

post/service/restv1/portal/resource/{resource_type}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"region_resource_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"category_id": 1,

"category_name": "string",

"region_id": 1

}`

tag/orgs/paths/1service1restv11portal1resource1{resource_type}1{resource_id}/put Update portal resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required

Responses

200

Resource updated

put/service/restv1/portal/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"region_resource_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"category_id": 1,

"category_name": "string",

"region_id": 1

}`

tag/orgs/paths/1service1restv11portal1resource1{resource_type}1{resource_id}/delete Delete portal resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Resource deleted

delete/service/restv1/portal/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"region_resource_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"category_id": 1,

"category_name": "string",

"region_id": 1

}`

tag/orgs/paths/1service1restv11portal1category~1{category_id}/put Update portal category

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
category_id
required
integer
name
required
string
description string
parent_category_id integer
display_priority string
attributes string
uri_path string

Responses

200

Category updated

put/service/restv1/portal/category/{category_id}

https://www.thrinacia.com/service/restv1/portal/category/{category\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"category_id": 0,

"name": "string",

"description": "string",

"parent_category_id": 0,

"display_priority": "string",

"attributes": "string",

"uri_path": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"category_id": 1,

"parent_category_id": 1,

"name": "string",

"description": "string",

"icon": "string",

"display_priority": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"uri_path_id": 1,

"path": "string",

"path_text": "string"

}`

tag/orgs/paths/1service1restv11portal1category~1{category_id}/delete Delete portal category

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
category_id
required
integer

Responses

200

Category deleted

delete/service/restv1/portal/category/{category_id}

https://www.thrinacia.com/service/restv1/portal/category/{category\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"category_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"category_id": 1,

"parent_category_id": 1,

"name": "string",

"description": "string",

"icon": "string",

"display_priority": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"subcategories": [ ],

"uri_paths": [ ]

}`

tag/orgs/paths/1service1restv11portal1page~1{page_id}/get Get portal page by ID

path Parameters
page_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
page_id integer

Responses

200

Page

get/service/restv1/portal/page/{page_id}

https://www.thrinacia.com/service/restv1/portal/page/{page\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"page_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "name": "string",\ \ "path": "string",\ \ "path_text": "string",\ \ "content": "string",\ \ "display_priority": "string",\ \ "meta": "string",\ \ "published": "string",\ \ "reserved": "string",\ \ "title": "string"\ \ }\ \ ]

tag/orgs/paths/1service1restv11portal1page~1{page_id}/put Update portal page

Authorizations:

ApiTokenAuth__SessionCookie

query Parameters
page_id integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
page_id
required
integer
title string
name string
content string
path string
path_text string
meta string
display_priority string
published string

Responses

200

Page updated

put/service/restv1/portal/page/{page_id}

https://www.thrinacia.com/service/restv1/portal/page/{page\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"page_id": 0,

"title": "string",

"name": "string",

"content": "string",

"path": "string",

"path_text": "string",

"meta": "string",

"display_priority": "string",

"published": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"uri_path_id": 1

}`

tag/orgs/paths/1service1restv11portal1page~1{page_id}/delete Delete portal page

Authorizations:

ApiTokenAuth__SessionCookie

query Parameters
page_id integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
page_id
required
integer

Responses

200

Page deleted

delete/service/restv1/portal/page/{page_id}

https://www.thrinacia.com/service/restv1/portal/page/{page\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"page_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"page_id": 1,

"uri_path_id": 1,

"name": "string",

"title": "string",

"content": "string",

"meta": "string",

"display_priority": "string",

"published": "string",

"reserved": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"path": "string",

"path_text": "string"

}`

tag/orgs/paths/1service1restv11portal1coupon~1{coupon_id}/get Get portal coupon by ID

path Parameters
coupon_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
coupon_id integer

Responses

200

Coupon

get/service/restv1/portal/coupon/{coupon_id}

https://www.thrinacia.com/service/restv1/portal/coupon/{coupon\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/orgs/paths/1service1restv11portal1coupon~1{coupon_id}/put Update portal coupon

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
coupon_id
required
integer
code string
name string
description string
discount_amount number
discount_percentage number
expires_date_time string
expires_quantity integer

Responses

200

Coupon updated

put/service/restv1/portal/coupon/{coupon_id}

https://www.thrinacia.com/service/restv1/portal/coupon/{coupon\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0,

"code": "string",

"name": "string",

"description": "string",

"discount_amount": 0,

"discount_percentage": 0,

"expires_date_time": "2019-08-24T14:15:22Z",

"expires_quantity": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"coupon_id": 1,

"code": "string",

"name": "string",

"description": "string",

"discount_amount": 10,

"discount_percentage": "string",

"expires_date_time": "string",

"expires_quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/orgs/paths/1service1restv11portal1coupon~1{coupon_id}/delete Delete portal coupon

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
coupon_id
required
integer

Responses

200

Coupon deleted

delete/service/restv1/portal/coupon/{coupon_id}

https://www.thrinacia.com/service/restv1/portal/coupon/{coupon\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"coupon_id": 1,

"code": "string",

"name": "string",

"description": "string",

"discount_amount": 10,

"discount_percentage": "string",

"expires_date_time": "string",

"expires_quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/orgs/paths/1service1restv11portal1person~1{person_id}/put Update portal person

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
first_name string
last_name string
bio string
person_id
required
string
person_status_id string
person_type_id string
email string
password string
password_confirm string
password_scheme string
password_scheme_options string
password_passthrough string
use_widgetmakr string
pid string
tracking_number string
attributes string

Responses

200

Person updated

put/service/restv1/portal/person/{person_id}

https://www.thrinacia.com/service/restv1/portal/person/{person\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"first_name": "string",

"last_name": "string",

"bio": "string",

"person_id": "string",

"person_status_id": "string",

"person_type_id": "string",

"email": "user@example.com",

"password": "string",

"password_confirm": "string",

"password_scheme": "string",

"password_scheme_options": "string",

"password_passthrough": "string",

"use_widgetmakr": "string",

"pid": "string",

"tracking_number": "string",

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"person_id": 1,

"person_type_id": 1,

"person_status_id": 1,

"first_name": "string",

"last_name": "string",

"email": "user@example.com",

"id": "string",

"bio": "string",

"attributes": "string",

"campaign_manager": true,

"campaign_backer": true,

"portal_admin": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/orgs/paths/1service1restv11portal1person~1{person_id}/delete Delete portal person

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer

Responses

200

Person deleted

delete/service/restv1/portal/person/{person_id}

https://www.thrinacia.com/service/restv1/portal/person/{person\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"person_id": 1,

"person_type_id": 1,

"person_status_id": 1,

"first_name": "string",

"last_name": "string",

"email": "user@example.com",

"id": "string",

"bio": "string",

"attributes": "string",

"campaign_manager": true,

"campaign_backer": true,

"portal_admin": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/orgs/paths/1service1restv11portal1person1attribute1{person_id}/put Update portal person attributes

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id
required
string
attributes string

Responses

200

Attributes updated

put/service/restv1/portal/person/attribute/{person_id}

https://www.thrinacia.com/service/restv1/portal/person/attribute/{person\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": "string",

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"person_id": 1,

"attributes": "string"

}`

tag/orgs/paths/1service1restv11portal1resource1{resource_type?}1{resource_id?}/get Get portal resource by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
resource_type
required
string
resource_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource

get/service/restv1/portal/resource/{resource_type?}/{resource_id?}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type?}/{resource\_id?}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"region_resource_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"category_id": 1,

"category_name": "string",

"region_id": 1

}`

tag/campaigns campaigns

tag/campaigns/paths/1service1restv11portal1campaign-revision/get Get portal campaign revisions

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_revision_id integer

Responses

200

Campaign revisions

get/service/restv1/portal/campaign-revision

https://www.thrinacia.com/service/restv1/portal/campaign-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "manager_first_name": "string",\ \ "manager_last_name": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv1~1campaign/get List campaigns

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id string
entry_status_id string
person_id string
category_id string
tag_id string
city_id string
currency_id string
name string
funding_goal number
starts string
ends string
runtime_days integer
filters string
use_path_lookup string
path_lookup_case_insensitive string
path string

Responses

200

Campaign list

get/service/restv1/campaign

https://www.thrinacia.com/service/restv1/campaign

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": "string",

"entry_status_id": "string",

"person_id": "string",

"category_id": "string",

"tag_id": "string",

"city_id": "string",

"currency_id": "string",

"name": "string",

"funding_goal": 0,

"starts": "2019-08-24T14:15:22Z",

"ends": "2019-08-24T14:15:22Z",

"runtime_days": 0,

"filters": "string",

"use_path_lookup": "string",

"path_lookup_case_insensitive": "string",

"path": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"entry_id": 1,\ \ "entry_status_id": 1,\ \ "raise_mode_id": 1,\ \ "profile_type_id": 1,\ \ "currency_id": 1,\ \ "duration_type_id": 1,\ \ "name": "string",\ \ "blurb": "string",\ \ "description": "string",\ \ "challenge": "string",\ \ "funding_goal": "string",\ \ "funded_amount": 10,\ \ "maximum_allowed_funds_raised": "string",\ \ "maximum_allowed_pledge": "string",\ \ "payment_threshold": "string",\ \ "starts": "string",\ \ "ends": "string",\ \ "runtime_days": "string",\ \ "ever_published": "string",\ \ "pledge_processing_started": "string",\ \ "featured": "string",\ \ "display_priority": "string",\ \ "hidden": "string",\ \ "private": "string",\ \ "backer_offset": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true,\ \ "timezone": "string",\ \ "timezone_abbrev": "string",\ \ "starts_date_time": "string",\ \ "ends_date_time": "string",\ \ "id": "string",\ \ "entry_status": "string",\ \ "campaign_duration": "string",\ \ "time_remaining": "string",\ \ "days_remaining": "string",\ \ "hours_remaining": "string",\ \ "minutes_remaining": "string",\ \ "seconds_remaining": "string",\ \ "days_remaining_inclusive": "string",\ \ "hours_remaining_inclusive": "string",\ \ "minutes_remaining_inclusive": "string",\ \ "seconds_remaining_inclusive": "string",\ \ "days_elapsed": "string",\ \ "hours_elapsed": "string",\ \ "minutes_elapsed": "string",\ \ "seconds_elapsed": "string",\ \ "days_elapsed_inclusive": "string",\ \ "hours_elapsed_inclusive": "string",\ \ "minutes_elapsed_inclusive": "string",\ \ "seconds_elapsed_inclusive": "string",\ \ "campaign_started": "string",\ \ "total_vote_up": "string",\ \ "total_vote_down": "string",\ \ "total_like": "string",\ \ "total_dislike": "string",\ \ "total_favour": "string",\ \ "total_unfavour": "string",\ \ "total_vote_diff": "string",\ \ "total_like_diff": "string",\ \ "total_favour_diff": "string",\ \ "entry_fee_percentage": "string",\ \ "entry_custom_status": "string",\ \ "funded_percentage": "string",\ \ "uri_paths": [ ],\ \ "categories": [ ],\ \ "cities": [ ],\ \ "files": [ ],\ \ "links": [ ],\ \ "managers": [ ],\ \ "currencies": [ ],\ \ "pledges": [ ],\ \ "business_organizations": [ ],\ \ "faqs": [ ],\ \ "settings": [ ],\ \ "groups": [ ],\ \ "total_shipping_cost": "string",\ \ "funded_amount_shipping_excluded": "string",\ \ "funded_percentage_shipping_excluded": "string",\ \ "total_backers": "string",\ \ "charity_helper_amount_total": 10\ \ }\ \ ]

tag/campaigns/paths/1service1restv1~1campaign/post Create campaign

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
name
required
string
description string
blurb string
funding_goal number
starts string
ends string
runtime_days integer
city_id string
category_id string
tag_id string
currency_id string
stripe_account_id string
widgetmakr_account_id string
manager_id string
raise_mode_id
required
string
profile_type_id
required
string
business_organization_id string
featured string
display_priority string
pledge_processing_started string
hidden string
private string
force_direct_transaction string
maximum_allowed_funds_raised number
duration_type_id string
uri_path string
use_widgetmakr string
group_id string
backer_offset string
created string
modified string

Responses

200

Campaign created

post/service/restv1/campaign

https://www.thrinacia.com/service/restv1/campaign

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"description": "string",

"blurb": "string",

"funding_goal": 0,

"starts": "2019-08-24T14:15:22Z",

"ends": "2019-08-24T14:15:22Z",

"runtime_days": 0,

"city_id": "string",

"category_id": "string",

"tag_id": "string",

"currency_id": "string",

"stripe_account_id": "string",

"widgetmakr_account_id": "string",

"manager_id": "string",

"raise_mode_id": "string",

"profile_type_id": "string",

"business_organization_id": "string",

"featured": "string",

"display_priority": "string",

"pledge_processing_started": "string",

"hidden": "string",

"private": "string",

"force_direct_transaction": "string",

"maximum_allowed_funds_raised": 0,

"duration_type_id": "string",

"uri_path": "string",

"use_widgetmakr": "string",

"group_id": "string",

"backer_offset": "string",

"created": "string",

"modified": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"entry_id": 1,

"entry_status_id": 1,

"raise_mode_id": 1,

"profile_type_id": 1,

"currency_id": 1,

"duration_type_id": 1,

"name": "string",

"blurb": "string",

"description": "string",

"challenge": "string",

"funding_goal": "string",

"funded_amount": 10,

"maximum_allowed_funds_raised": "string",

"maximum_allowed_pledge": "string",

"payment_threshold": "string",

"starts": "string",

"ends": "string",

"runtime_days": "string",

"ever_published": "string",

"pledge_processing_started": "string",

"featured": "string",

"display_priority": "string",

"hidden": "string",

"private": "string",

"backer_offset": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"timezone": "string",

"timezone_abbrev": "string",

"starts_date_time": "string",

"ends_date_time": "string",

"id": "string",

"entry_status": "string",

"campaign_duration": "string",

"time_remaining": "string",

"days_remaining": "string",

"hours_remaining": "string",

"minutes_remaining": "string",

"seconds_remaining": "string",

"days_remaining_inclusive": "string",

"hours_remaining_inclusive": "string",

"minutes_remaining_inclusive": "string",

"seconds_remaining_inclusive": "string",

"days_elapsed": "string",

"hours_elapsed": "string",

"minutes_elapsed": "string",

"seconds_elapsed": "string",

"days_elapsed_inclusive": "string",

"hours_elapsed_inclusive": "string",

"minutes_elapsed_inclusive": "string",

"seconds_elapsed_inclusive": "string",

"campaign_started": "string",

"total_vote_up": "string",

"total_vote_down": "string",

"total_like": "string",

"total_dislike": "string",

"total_favour": "string",

"total_unfavour": "string",

"total_vote_diff": "string",

"total_like_diff": "string",

"total_favour_diff": "string",

"entry_fee_percentage": "string",

"entry_custom_status": "string",

"funded_percentage": "string",

"uri_paths": [ ],

"categories": [ ],

"cities": [ ],

"files": [ ],

"links": [ ],

"managers": [ ],

"currencies": [ ],

"pledges": [ ],

"business_organizations": [ ],

"faqs": [ ],

"settings": [ ],

"groups": [ ],

"total_shipping_cost": "string",

"funded_amount_shipping_excluded": "string",

"funded_percentage_shipping_excluded": "string",

"total_backers": "string",

"charity_helper_amount_total": 10

}`

tag/campaigns/paths/1service1restv11campaign1status/get List campaign statuses

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_status_id integer

Responses

200

Status list

get/service/restv1/campaign/status

https://www.thrinacia.com/service/restv1/campaign/status

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_status_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1raise-mode/get List campaign raise modes

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
raise_mode_id integer

Responses

200

Raise mode list

get/service/restv1/campaign/raise-mode

https://www.thrinacia.com/service/restv1/campaign/raise-mode

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"raise_mode_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1pledge-level/get Get pledge levels

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id integer
pledge_level_id integer

Responses

200

Pledge levels

get/service/restv1/campaign/{entry_id}/pledge-level

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "pledge_level_id": 1,\ \ "name": "string",\ \ "description": "string",\ \ "amount": "string",\ \ "maximum_amount": 10,\ \ "estimated_delivery_time": "string",\ \ "item_limit": "string",\ \ "attributes": "string",\ \ "expires": "string",\ \ "priority": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true,\ \ "entry_pledge_level_id": 1,\ \ "coupon_id": 1,\ \ "shipping": [ ],\ \ "coupon": [ ],\ \ "currencies": [ ],\ \ "total_pledges": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1pledge-level/post Create pledge level

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
name
required
string
description string
amount number
estimated_delivery_time string
item_limit integer
attributes string
expires string
coupon_id integer
priority number

Responses

200

Pledge level created

post/service/restv1/campaign/{entry_id}/pledge-level

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"name": "string",

"description": "string",

"amount": 0,

"estimated_delivery_time": "2019-08-24T14:15:22Z",

"item_limit": 0,

"attributes": "string",

"expires": "2019-08-24T14:15:22Z",

"coupon_id": 0,

"priority": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"pledge_level_id": 1,

"name": "string",

"description": "string",

"amount": "string",

"maximum_amount": 10,

"estimated_delivery_time": "string",

"item_limit": "string",

"attributes": "string",

"expires": "string",

"priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"entry_pledge_level_id": 1,

"coupon_id": 1,

"shipping": [ ],

"coupon": [ ],

"currencies": [ ],

"total_pledges": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1pledge-level1{pledge_level_id}~1shipping-option/get Get pledge level shipping options

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id integer

Responses

200

Shipping options

get/service/restv1/campaign/{entry_id}/pledge-level/{pledge_level_id}/shipping-option

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level/{pledge\_level\_id}/shipping-option

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"shipping_option_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "shipping_option_id": 1,\ \ "shipping_option_type_id": 1,\ \ "country_id": 1,\ \ "subcountry_id": 1,\ \ "name": "string",\ \ "description": "string",\ \ "cost": "string",\ \ "attributes": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "country": "string",\ \ "country_code_iso3166_1": "string",\ \ "subcountry": "string",\ \ "subcountry_code_iso3166_2": "string",\ \ "shipping_option_type": "string",\ \ "country_native_name": "string",\ \ "subcountry_native_name": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}1pledge-level1{pledge_level_id}~1shipping-option/post Create pledge level shipping option

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_type_id
required
integer
country_id integer
subcountry_id integer
name string
description string
cost number
attributes string

Responses

200

Shipping option created

post/service/restv1/campaign/{entry_id}/pledge-level/{pledge_level_id}/shipping-option

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level/{pledge\_level\_id}/shipping-option

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"shipping_option_type_id": 0,

"country_id": 0,

"subcountry_id": 0,

"name": "string",

"description": "string",

"cost": 0,

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"shipping_option_id": 1,

"shipping_option_type_id": 1,

"country_id": 1,

"subcountry_id": 1,

"name": "string",

"description": "string",

"cost": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country": "string",

"country_code_iso3166_1": "string",

"subcountry": "string",

"subcountry_code_iso3166_2": "string",

"shipping_option_type": "string",

"country_native_name": "string",

"subcountry_native_name": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1stripe-account/get Get campaign Stripe account

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id integer

Responses

200

Stripe account data

get/service/restv1/campaign/{entry_id}/stripe-account

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/stripe-account

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1resource/get Get campaign resources

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource list

get/service/restv1/campaign/{entry_id}/resource

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": 1,\ \ "file_id": 1,\ \ "file_type_id": 1,\ \ "name": "string",\ \ "path_internal": "string",\ \ "path_external": "string",\ \ "disabled": false,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "resource_type": "file",\ \ "entry_file_id": 1,\ \ "region_name": "string",\ \ "region_id": 1,\ \ "resource_content_type": "string",\ \ "resource_content_type_id": 1,\ \ "file_type": "string",\ \ "description": "string",\ \ "mime_type": "string",\ \ "extension": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1resource-revision/get Get campaign resource revisions

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
resource_revision_id string
resource_type
required
string

Responses

200

Resource revisions

get/service/restv1/campaign/{entry_id}/resource-revision

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"resource_revision_id": "string",

"resource_type": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": 1,\ \ "file_revision_id": 1,\ \ "file_type_id": 1,\ \ "name": "string",\ \ "path_internal": "string",\ \ "path_external": "string",\ \ "disabled": false,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "resource_type": "file",\ \ "entry_file_revision_id": 1,\ \ "region_name": "string",\ \ "region_id": 1,\ \ "resource_content_type": "string",\ \ "resource_content_type_id": 1,\ \ "file_type": "string",\ \ "description": "string",\ \ "mime_type": "string",\ \ "extension": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1faq/get Get campaign FAQs

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id integer

Responses

200

FAQ list

get/service/restv1/campaign/{entry_id}/faq

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "faq_id": 1,\ \ "name": "string",\ \ "description": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true,\ \ "faq_pairs": [ ]\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1faq/post Create campaign FAQ

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
name
required
string
description string

Responses

200

FAQ created

post/service/restv1/campaign/{entry_id}/faq

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq1{faq_id}~1faq-pair/get Get campaign FAQ pairs

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer
faq_pair_id integer

Responses

200

FAQ pair list

get/service/restv1/campaign/{entry_id}/faq/{faq_id}/faq-pair

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq/{faq\_id}/faq-pair

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"faq_pair_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1faq-revision/get Get FAQ revisions

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id integer

Responses

200

FAQ revision list

get/service/restv1/campaign/{entry_id}/faq-revision

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "faq_revision_id": 1,\ \ "name": "string",\ \ "description": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true,\ \ "faq_pairs": [ ]\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1faq-revision/post Create FAQ revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
name
required
string
description string

Responses

200

FAQ revision created

post/service/restv1/campaign/{entry_id}/faq-revision

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_revision_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq-revision1{faq_revision_id}~1faq-pair-revision/get Get FAQ pair revisions

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id integer

Responses

200

FAQ pair revision list

get/service/restv1/campaign/{entry_id}/faq-revision/{faq_revision_id}/faq-pair-revision

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision/{faq\_revision\_id}/faq-pair-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"faq_pair_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1video-check/get Validate campaign video URL

query Parameters
url string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
link
required
string

Responses

200

Validation result

get/service/restv1/campaign/video-check

https://www.thrinacia.com/service/restv1/campaign/video-check

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"link": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"result": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1verify/get Get campaign verification status

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
verify_type_id integer

Responses

200

Verification status

get/service/restv1/campaign/{entry_id}/verify

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/verify

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"verify_type_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"verify_id": 1

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1verify/post Create/update campaign verification

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
verify_type_id
required
integer
data
required
string

Responses

200

Verification updated

post/service/restv1/campaign/{entry_id}/verify

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/verify

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"verify_type_id": 0,

"data": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"verify_id": 1

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1note/get Get campaign notes

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_note_id integer

Responses

200

Note list

get/service/restv1/campaign/{entry_id}/note

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/note

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_note_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "entry_note_id": 1,\ \ "entry_id": 1,\ \ "value": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1note/post Create campaign note

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
value
required
string

Responses

200

Note created

post/service/restv1/campaign/{entry_id}/note

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/note

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"value": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_note_id": 1,

"entry_id": 1,

"value": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1stream/get Get campaign stream

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stream_id integer
entry_id
required
integer

Responses

200

Stream list

get/service/restv1/campaign/{entry_id}/stream

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/stream

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stream_id": 0,

"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "stream_id": 1,\ \ "stream_type_id": 1,\ \ "entry_id": 1,\ \ "title": "string",\ \ "message": "string",\ \ "display_priority": "string",\ \ "published": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "stream_type": "string",\ \ "stream_backers": [ ]\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1stream/post Create campaign stream entry

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stream_type_id
required
integer
entry_id
required
integer
person_id string
title
required
string
message
required
string
published string
display_priority string

Responses

200

Stream entry created

post/service/restv1/campaign/{entry_id}/stream

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/stream

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stream_type_id": 0,

"entry_id": 0,

"person_id": "string",

"title": "string",

"message": "string",

"published": "string",

"display_priority": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"stream_id": 1,

"stream_type_id": 1,

"entry_id": 1,

"title": "string",

"message": "string",

"display_priority": "string",

"published": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"stream_type": "string",

"stream_backers": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1stream-notify/post Notify campaign stream subscribers

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stream_id integer
entry_id
required
integer

Responses

200

Notification dispatched

post/service/restv1/campaign/{entry_id}/stream-notify

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/stream-notify

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stream_id": 0,

"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"first_name": "string",

"last_name": "string",

"email": "user@example.com"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1setting/get Get campaign settings

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
setting string

Responses

200

Settings

get/service/restv1/campaign/{entry_id}/setting

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"setting": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1setting/delete Delete campaign settings

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
public string

Responses

200

Settings deleted

delete/service/restv1/campaign/{entry_id}/setting

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"public": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"success": true

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1setting-revision/get Get campaign setting revisions

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
setting string

Responses

200

Setting revision list

get/service/restv1/campaign/{entry_id}/setting-revision

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/setting-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"setting": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1setting-revision/delete Delete campaign setting revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileSettingRevisionDeleteRequest)

Responses

200

Setting revision deleted

delete/service/restv1/campaign/{entry_id}/setting-revision

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/setting-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"success": true

}`

tag/campaigns/paths/1service1restv1~1campaign-group/get Get campaign groups

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
group_id string

Responses

200

Group list

get/service/restv1/campaign-group

https://www.thrinacia.com/service/restv1/campaign-group

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"group_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv1~1campaign-group/post Create campaign group

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
name
required
string
description string

Responses

200

Group created

post/service/restv1/campaign-group

https://www.thrinacia.com/service/restv1/campaign-group

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1comment/get Get campaign comments

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id integer

Responses

200

Comment list

get/service/restv1/campaign/{entry_id}/comment

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "comment_id": 1,\ \ "parent_comment_id": 1,\ \ "title": "string",\ \ "anonymous": "string",\ \ "message": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "person_id": 1,\ \ "entry_id": 1,\ \ "comment_person": [ ],\ \ "total_votes_up": "string",\ \ "total_votes_down": "string",\ \ "total_likes": "string",\ \ "total_dislikes": "string",\ \ "total_favours": "string",\ \ "total_unfavours": "string",\ \ "logged_in_person_has_voted_up": "string",\ \ "logged_in_person_has_voted_down": "string",\ \ "logged_in_person_has_likes": "string",\ \ "logged_in_person_has_dislikes": "string",\ \ "logged_in_person_has_favours": "string",\ \ "logged_in_person_has_unfavours": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1comment/post Create campaign comment

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
person_id integer
title string
anonymous string
message
required
string

Responses

200

Comment created

post/service/restv1/campaign/{entry_id}/comment

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"person_id": 0,

"title": "string",

"anonymous": "string",

"message": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_id": 1,

"parent_comment_id": 1,

"title": "string",

"anonymous": "string",

"message": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"entry_id": 1,

"comment_person": [ ],

"total_votes_up": "string",

"total_votes_down": "string",

"total_likes": "string",

"total_dislikes": "string",

"total_favours": "string",

"total_unfavours": "string",

"logged_in_person_has_voted_up": "string",

"logged_in_person_has_voted_down": "string",

"logged_in_person_has_likes": "string",

"logged_in_person_has_dislikes": "string",

"logged_in_person_has_favours": "string",

"logged_in_person_has_unfavours": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1comment1{comment_id}~1comment-action/get Get comment actions

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id
required
integer
comment_action_id integer

Responses

200

Comment action list

get/service/restv1/campaign/{entry_id}/comment/{comment_id}/comment-action

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment/{comment\_id}/comment-action

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0,

"comment_action_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "comment_action_id": 1,\ \ "comment_action_type_id": 1,\ \ "comment_id": 1,\ \ "person_id": 1,\ \ "anonymous": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "comment_action_type": "string",\ \ "comment_action_person": [ ]\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}1comment1{comment_id}~1comment-action/post Create comment action

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id
required
integer
comment_action_type_id
required
integer
person_id integer
anonymous string

Responses

200

Comment action created

post/service/restv1/campaign/{entry_id}/comment/{comment_id}/comment-action

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment/{comment\_id}/comment-action

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0,

"comment_action_type_id": 0,

"person_id": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_action_id": 1,

"comment_action_type_id": 1,

"comment_id": 1,

"person_id": 1,

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"comment_action_type": "string",

"comment_action_person": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1action/get Get campaign actions

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_action_id integer

Responses

200

Action list

get/service/restv1/campaign/{entry_id}/action

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/action

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_action_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "entry_action_id": 1,\ \ "entry_action_type_id": 1,\ \ "entry_id": 1,\ \ "person_id": 1,\ \ "anonymous": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "entry_action_type": "string",\ \ "entry_action_person": [ ]\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1action/post Create campaign action

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_action_type_id
required
integer
person_id integer
anonymous string

Responses

200

Action created

post/service/restv1/campaign/{entry_id}/action

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/action

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_action_type_id": 0,

"person_id": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entry_action_id": 1,

"entry_action_type_id": 1,

"entry_id": 1,

"person_id": 1,

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"entry_action_type": "string",

"entry_action_person": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1status-check/get Get campaign status check

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer

Responses

200

Status check

get/service/restv1/campaign/{entry_id}/status-check

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/status-check

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1revision/get Get campaign revisions

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_revision_id integer

Responses

200

Revision list

get/service/restv1/campaign/{entry_id}/revision

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "manager_first_name": "string",\ \ "manager_last_name": "string",\ \ "entry_revision_id": 1,\ \ "entry_id": 1,\ \ "name": "string",\ \ "blurb": "string",\ \ "description": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1revision/post Create campaign revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
name
required
string
description string
blurb string
created string
modified string

Responses

200

Revision created

post/service/restv1/campaign/{entry_id}/revision

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"name": "string",

"description": "string",

"blurb": "string",

"created": "string",

"modified": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"manager_first_name": "string",

"manager_last_name": "string",

"entry_revision_id": 1,

"entry_id": 1,

"name": "string",

"blurb": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1replicate/post Replicate campaign

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
name string
description string
blurb string
funding_goal number
starts string
ends string
runtime_days integer
city_id string
category_id string
currency_id string
stripe_account_id string
raise_mode_id string
profile_type_id string
business_organization_id string
featured string
display_priority string
hidden string
private string
force_direct_transaction string
maximum_allowed_funds_raised number
duration_type_id string
uri_path string
skip_path_update string
backer_offset string
created string
modified string

Responses

200

Replication result

post/service/restv1/campaign/{entry_id}/replicate

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/replicate

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"name": "string",

"description": "string",

"blurb": "string",

"funding_goal": 0,

"starts": "2019-08-24T14:15:22Z",

"ends": "2019-08-24T14:15:22Z",

"runtime_days": 0,

"city_id": "string",

"category_id": "string",

"currency_id": "string",

"stripe_account_id": "string",

"raise_mode_id": "string",

"profile_type_id": "string",

"business_organization_id": "string",

"featured": "string",

"display_priority": "string",

"hidden": "string",

"private": "string",

"force_direct_transaction": "string",

"maximum_allowed_funds_raised": 0,

"duration_type_id": "string",

"uri_path": "string",

"skip_path_update": "string",

"backer_offset": "string",

"created": "string",

"modified": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_manager_id": 1,

"person_id": 1,

"entry_id": 1,

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}~1coupon/get Get campaign coupons

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
coupon_id integer

Responses

200

Coupon list

get/service/restv1/campaign/{entry_id}/coupon

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/coupon

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1image1want_campaign_home/get Campaign home image variant

Responses

200

Image

get/image/want_campaign_home

https://www.thrinacia.com/image/want\_campaign\_home

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_explore/get Campaign explore image variant

Responses

200

Image

get/image/want_campaign_explore

https://www.thrinacia.com/image/want\_campaign\_explore

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_detail/get Campaign detail image variant

Responses

200

Image

get/image/want_campaign_detail

https://www.thrinacia.com/image/want\_campaign\_detail

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_detail_large/get Campaign detail large image variant

Responses

200

Image

get/image/want_campaign_detail_large

https://www.thrinacia.com/image/want\_campaign\_detail\_large

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_profile/get Campaign profile image variant

Responses

200

Image

get/image/want_campaign_profile

https://www.thrinacia.com/image/want\_campaign\_profile

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_thumbnail/get Campaign thumbnail image

Responses

200

Image

get/image/want_campaign_thumbnail

https://www.thrinacia.com/image/want\_campaign\_thumbnail

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_thumbnail_large/get Campaign thumbnail large image

Responses

200

Image

get/image/want_campaign_thumbnail_large

https://www.thrinacia.com/image/want\_campaign\_thumbnail\_large

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_reward_image/get Campaign reward image

Responses

200

Image

get/image/want_campaign_reward_image

https://www.thrinacia.com/image/want\_campaign\_reward\_image

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_top_header_image/get Campaign top header image

Responses

200

Image

get/image/want_campaign_top_header_image

https://www.thrinacia.com/image/want\_campaign\_top\_header\_image

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_progress_status/get Campaign progress status image

Responses

200

Image

get/image/want_campaign_progress_status

https://www.thrinacia.com/image/want\_campaign\_progress\_status

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_thumbnail_medium/get Campaign thumbnail medium image

Responses

200

Image

get/image/want_campaign_thumbnail_medium

https://www.thrinacia.com/image/want\_campaign\_thumbnail\_medium

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_thumbnail_xl/get Campaign thumbnail XL image

Responses

200

Image

get/image/want_campaign_thumbnail_xl

https://www.thrinacia.com/image/want\_campaign\_thumbnail\_xl

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_large/get Campaign large image

Responses

200

Image

get/image/want_campaign_large

https://www.thrinacia.com/image/want\_campaign\_large

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_medium/get Campaign medium image

Responses

200

Image

get/image/want_campaign_medium

https://www.thrinacia.com/image/want\_campaign\_medium

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1image1want_campaign_small/get Campaign small image

Responses

200

Image

get/image/want_campaign_small

https://www.thrinacia.com/image/want\_campaign\_small

Response samples

  • 200

Content type

image/*

Copy

string

tag/campaigns/paths/1service1restv11campaign1{entry_id}1pledge-level1{pledge_level_id}/get Get pledge level by ID

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id integer
pledge_level_id integer

Responses

200

Pledge level

get/service/restv1/campaign/{entry_id}/pledge-level/{pledge_level_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level/{pledge\_level\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1pledge-level1{pledge_level_id}/put Update pledge level by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer
name string
description string
amount number
estimated_delivery_time string
item_limit integer
attributes string
expires string
coupon_id integer
priority number

Responses

200

Pledge level updated

put/service/restv1/campaign/{entry_id}/pledge-level/{pledge_level_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level/{pledge\_level\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"name": "string",

"description": "string",

"amount": 0,

"estimated_delivery_time": "2019-08-24T14:15:22Z",

"item_limit": 0,

"attributes": "string",

"expires": "2019-08-24T14:15:22Z",

"coupon_id": 0,

"priority": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"pledge_level_id": 1,

"name": "string",

"description": "string",

"amount": "string",

"maximum_amount": 10,

"estimated_delivery_time": "string",

"item_limit": "string",

"attributes": "string",

"expires": "string",

"priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"entry_pledge_level_id": 1,

"coupon_id": 1,

"shipping": [ ],

"coupon": [ ],

"currencies": [ ],

"total_pledges": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1pledge-level1{pledge_level_id}/delete Delete pledge level by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer

Responses

200

Pledge level deleted

delete/service/restv1/campaign/{entry_id}/pledge-level/{pledge_level_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level/{pledge\_level\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"pledge_level_id": 1,

"name": "string",

"description": "string",

"amount": "string",

"maximum_amount": 10,

"estimated_delivery_time": "string",

"item_limit": "string",

"attributes": "string",

"expires": "string",

"priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"entry_pledge_level_id": 1,

"coupon_id": 1,

"shipping": [ ],

"coupon": [ ],

"currencies": [ ],

"total_pledges": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1pledge-level1{pledge_level_id}1shipping-option1{shipping_option_id}/get Get shipping option by ID

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id integer

Responses

200

Shipping option

get/service/restv1/campaign/{entry_id}/pledge-level/{pledge_level_id}/shipping-option/{shipping_option_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level/{pledge\_level\_id}/shipping-option/{shipping\_option\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"shipping_option_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1pledge-level1{pledge_level_id}1shipping-option1{shipping_option_id}/put Update shipping option by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer
shipping_option_type_id
required
integer
country_id integer
subcountry_id integer
name string
description string
cost number
attributes string

Responses

200

Shipping option updated

put/service/restv1/campaign/{entry_id}/pledge-level/{pledge_level_id}/shipping-option/{shipping_option_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level/{pledge\_level\_id}/shipping-option/{shipping\_option\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"shipping_option_id": 0,

"shipping_option_type_id": 0,

"country_id": 0,

"subcountry_id": 0,

"name": "string",

"description": "string",

"cost": 0,

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"shipping_option_id": 1,

"shipping_option_type_id": 1,

"country_id": 1,

"subcountry_id": 1,

"name": "string",

"description": "string",

"cost": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country": "string",

"country_code_iso3166_1": "string",

"subcountry": "string",

"subcountry_code_iso3166_2": "string",

"shipping_option_type": "string",

"country_native_name": "string",

"subcountry_native_name": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1pledge-level1{pledge_level_id}1shipping-option1{shipping_option_id}/delete Delete shipping option by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer

Responses

200

Shipping option deleted

delete/service/restv1/campaign/{entry_id}/pledge-level/{pledge_level_id}/shipping-option/{shipping_option_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-level/{pledge\_level\_id}/shipping-option/{shipping\_option\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"shipping_option_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"shipping_option_id": 1,

"shipping_option_type_id": 1,

"country_id": 1,

"subcountry_id": 1,

"name": "string",

"description": "string",

"cost": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country": "string",

"country_code_iso3166_1": "string",

"subcountry": "string",

"subcountry_code_iso3166_2": "string",

"shipping_option_type": "string",

"country_native_name": "string",

"subcountry_native_name": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1resource1{resource_type}/get Get campaign resources by type

path Parameters
entry_id
required
integer
resource_type
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource list

get/service/restv1/campaign/{entry_id}/resource/{resource_type}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1resource1{resource_type}/post Create campaign resource by type

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
resource_type
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required

Responses

200

Resource created

post/service/restv1/campaign/{entry_id}/resource/{resource_type}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1resource1{resource_type}~1{resource_id}/get Get campaign resource by ID

path Parameters
entry_id
required
integer
resource_type
required
string
resource_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource

get/service/restv1/campaign/{entry_id}/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1resource1{resource_type}~1{resource_id}/put Update campaign resource by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
resource_type
required
string
resource_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required

Responses

200

Resource updated

put/service/restv1/campaign/{entry_id}/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1resource1{resource_type}~1{resource_id}/delete Delete campaign resource by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
resource_type
required
string
resource_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Resource deleted

delete/service/restv1/campaign/{entry_id}/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1resource-revision1{resource_type}/get Get campaign resource revisions by type

path Parameters
entry_id
required
integer
resource_type
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
resource_revision_id string
resource_type
required
string

Responses

200

Resource revision list

get/service/restv1/campaign/{entry_id}/resource-revision/{resource_type}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource-revision/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"resource_revision_id": "string",

"resource_type": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1resource-revision1{resource_type}/post Create campaign resource revision by type

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
resource_type
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required
entry_id
required
integer
resource_type
required
string
resource_content_type string
resource
required
string
region_id string
label string

Responses

200

Resource revision created

post/service/restv1/campaign/{entry_id}/resource-revision/{resource_type}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource-revision/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"entry_id": 0,

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"region_id": "string",

"label": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_revision_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_revision_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1resource-revision1{resource_type}~1{resource_revision_id}/put Update campaign resource revision by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
resource_type
required
string
resource_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
resource_revision_id
required
string
resource_type string
resource_content_type string
resource string
region_id string
label string
file_sync string
file_sync_resource_id string

Responses

200

Resource revision updated

put/service/restv1/campaign/{entry_id}/resource-revision/{resource_type}/{resource_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/resource-revision/{resource\_type}/{resource\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"resource_revision_id": "string",

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"region_id": "string",

"label": "string",

"file_sync": "string",

"file_sync_resource_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_revision_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_revision_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq1{faq_id}/get Get FAQ by ID

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id integer

Responses

200

FAQ

get/service/restv1/campaign/{entry_id}/faq/{faq_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq/{faq\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq1{faq_id}/put Update FAQ by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer
name
required
string
description string

Responses

200

FAQ updated

put/service/restv1/campaign/{entry_id}/faq/{faq_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq/{faq\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq1{faq_id}/delete Delete FAQ by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer

Responses

200

FAQ deleted

delete/service/restv1/campaign/{entry_id}/faq/{faq_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq/{faq\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq1{faq_id}1faq-pair1{faq_pair_id}/get Get FAQ pair by ID

path Parameters
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer
faq_pair_id integer

Responses

200

FAQ pair

get/service/restv1/campaign/{entry_id}/faq/{faq_id}/faq-pair/{faq_pair_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq/{faq\_id}/faq-pair/{faq\_pair\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"faq_pair_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "faq_pair_id": 1,\ \ "faq_id": 1,\ \ "question": "string",\ \ "answer": "string",\ \ "display_priority": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq1{faq_id}1faq-pair1{faq_pair_id}/put Update FAQ pair by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
question
required
string
answer
required
string
display_priority string

Responses

200

FAQ pair updated

put/service/restv1/campaign/{entry_id}/faq/{faq_id}/faq-pair/{faq_pair_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq/{faq\_id}/faq-pair/{faq\_pair\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"faq_pair_id": 0,

"question": "string",

"answer": "string",

"display_priority": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"faq_pair_id": 1,

"faq_id": 1,

"question": "string",

"answer": "string",

"display_priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq1{faq_id}1faq-pair1{faq_pair_id}/delete Delete FAQ pair by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer

Responses

200

FAQ pair deleted

delete/service/restv1/campaign/{entry_id}/faq/{faq_id}/faq-pair/{faq_pair_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq/{faq\_id}/faq-pair/{faq\_pair\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"faq_pair_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"faq_pair_id": 1,

"faq_id": 1,

"question": "string",

"answer": "string",

"display_priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq-revision1{faq_revision_id}/get Get FAQ revision by ID

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id integer

Responses

200

FAQ revision

get/service/restv1/campaign/{entry_id}/faq-revision/{faq_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision/{faq\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq-revision1{faq_revision_id}/put Update FAQ revision by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer
name
required
string
description string

Responses

200

FAQ revision updated

put/service/restv1/campaign/{entry_id}/faq-revision/{faq_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision/{faq\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_revision_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq-revision1{faq_revision_id}/delete Delete FAQ revision by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer

Responses

200

FAQ revision deleted

delete/service/restv1/campaign/{entry_id}/faq-revision/{faq_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision/{faq\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_revision_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq-revision1{faq_revision_id}1faq-pair-revision1{faq_pair_revision_id}/get Get FAQ pair revision by ID

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id integer

Responses

200

FAQ pair revision

get/service/restv1/campaign/{entry_id}/faq-revision/{faq_revision_id}/faq-pair-revision/{faq_pair_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision/{faq\_revision\_id}/faq-pair-revision/{faq\_pair\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"faq_pair_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "faq_pair_revision_id": 1,\ \ "faq_revision_id": 1,\ \ "question": "string",\ \ "answer": "string",\ \ "display_priority": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq-revision1{faq_revision_id}1faq-pair-revision1{faq_pair_revision_id}/put Update FAQ pair revision by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer
question
required
string
answer
required
string
display_priority string

Responses

200

FAQ pair revision updated

put/service/restv1/campaign/{entry_id}/faq-revision/{faq_revision_id}/faq-pair-revision/{faq_pair_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision/{faq\_revision\_id}/faq-pair-revision/{faq\_pair\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"faq_pair_revision_id": 0,

"question": "string",

"answer": "string",

"display_priority": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"faq_pair_revision_id": 1,

"faq_revision_id": 1,

"question": "string",

"answer": "string",

"display_priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1faq-revision1{faq_revision_id}1faq-pair-revision1{faq_pair_revision_id}/delete Delete FAQ pair revision by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer

Responses

200

FAQ pair revision deleted

delete/service/restv1/campaign/{entry_id}/faq-revision/{faq_revision_id}/faq-pair-revision/{faq_pair_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/faq-revision/{faq\_revision\_id}/faq-pair-revision/{faq\_pair\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"faq_pair_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"faq_pair_revision_id": 1,

"faq_revision_id": 1,

"question": "string",

"answer": "string",

"display_priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1note1{entry_note_id}/get Get campaign note by ID

path Parameters
entry_id
required
integer
entry_note_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_note_id integer

Responses

200

Note

get/service/restv1/campaign/{entry_id}/note/{entry_note_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/note/{entry\_note\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_note_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1note1{entry_note_id}/put Update campaign note by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
entry_note_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_note_id
required
integer
value
required
string

Responses

200

Note updated

put/service/restv1/campaign/{entry_id}/note/{entry_note_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/note/{entry\_note\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_note_id": 0,

"value": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_note_id": 1,

"entry_id": 1,

"value": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1note1{entry_note_id}/delete Delete campaign note by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
entry_note_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_note_id
required
integer

Responses

200

Note deleted

delete/service/restv1/campaign/{entry_id}/note/{entry_note_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/note/{entry\_note\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_note_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_note_id": 1,

"entry_id": 1,

"value": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1stream1{stream_id}/get Get campaign stream entry by ID

path Parameters
entry_id
required
integer
stream_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stream_id integer
entry_id
required
integer

Responses

200

Stream entry

get/service/restv1/campaign/{entry_id}/stream/{stream_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/stream/{stream\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stream_id": 0,

"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "stream_id": 1,\ \ "stream_type_id": 1,\ \ "entry_id": 1,\ \ "title": "string",\ \ "message": "string",\ \ "display_priority": "string",\ \ "published": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "stream_type": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{entry_id}1stream1{stream_id}/put Update campaign stream entry by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
stream_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stream_id
required
integer
stream_type_id integer
entry_id
required
integer
person_id string
title string
message string
published string
display_priority string

Responses

200

Stream entry updated

put/service/restv1/campaign/{entry_id}/stream/{stream_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/stream/{stream\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stream_id": 0,

"stream_type_id": 0,

"entry_id": 0,

"person_id": "string",

"title": "string",

"message": "string",

"published": "string",

"display_priority": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"stream_id": 1,

"stream_type_id": 1,

"entry_id": 1,

"title": "string",

"message": "string",

"display_priority": "string",

"published": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"stream_type": "string",

"stream_backers": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1stream1{stream_id}/delete Delete campaign stream entry by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
stream_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stream_id
required
integer
entry_id
required
integer

Responses

200

Stream entry deleted

delete/service/restv1/campaign/{entry_id}/stream/{stream_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/stream/{stream\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stream_id": 0,

"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"stream_id": 1,

"stream_type_id": 1,

"entry_id": 1,

"title": "string",

"message": "string",

"display_priority": "string",

"published": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"stream_type": "string",

"stream_backers": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1comment1{comment_id}/get Get comment by ID

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id integer

Responses

200

Comment

get/service/restv1/campaign/{entry_id}/comment/{comment_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment/{comment\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1comment1{comment_id}/put Update comment by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
person_id integer
comment_id
required
integer
title string
anonymous string
message
required
string

Responses

200

Comment updated

put/service/restv1/campaign/{entry_id}/comment/{comment_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment/{comment\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"person_id": 0,

"comment_id": 0,

"title": "string",

"anonymous": "string",

"message": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_id": 1,

"parent_comment_id": 1,

"title": "string",

"anonymous": "string",

"message": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"entry_id": 1,

"comment_person": [ ],

"total_votes_up": "string",

"total_votes_down": "string",

"total_likes": "string",

"total_dislikes": "string",

"total_favours": "string",

"total_unfavours": "string",

"logged_in_person_has_voted_up": "string",

"logged_in_person_has_voted_down": "string",

"logged_in_person_has_likes": "string",

"logged_in_person_has_dislikes": "string",

"logged_in_person_has_favours": "string",

"logged_in_person_has_unfavours": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1comment1{comment_id}/delete Delete comment by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id
required
integer

Responses

200

Comment deleted

delete/service/restv1/campaign/{entry_id}/comment/{comment_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment/{comment\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_id": 1,

"parent_comment_id": 1,

"title": "string",

"anonymous": "string",

"message": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"entry_id": 1,

"comment_person": [ ],

"total_votes_up": "string",

"total_votes_down": "string",

"total_likes": "string",

"total_dislikes": "string",

"total_favours": "string",

"total_unfavours": "string",

"logged_in_person_has_voted_up": "string",

"logged_in_person_has_voted_down": "string",

"logged_in_person_has_likes": "string",

"logged_in_person_has_dislikes": "string",

"logged_in_person_has_favours": "string",

"logged_in_person_has_unfavours": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1comment1{comment_id}1comment-action1{comment_action_id}/get Get comment action by ID

path Parameters
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id
required
integer
comment_action_id integer

Responses

200

Comment action

get/service/restv1/campaign/{entry_id}/comment/{comment_id}/comment-action/{comment_action_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment/{comment\_id}/comment-action/{comment\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0,

"comment_action_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1comment1{comment_id}1comment-action1{comment_action_id}/put Update comment action by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer
comment_action_type_id integer
person_id integer
anonymous string

Responses

200

Comment action updated

put/service/restv1/campaign/{entry_id}/comment/{comment_id}/comment-action/{comment_action_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment/{comment\_id}/comment-action/{comment\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0,

"comment_action_id": 0,

"comment_action_type_id": 0,

"person_id": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_action_id": 1,

"comment_action_type_id": 1,

"comment_id": 1,

"person_id": 1,

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"comment_action_type": "string",

"comment_action_person": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1comment1{comment_id}1comment-action1{comment_action_id}/delete Delete comment action by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer

Responses

200

Comment action deleted

delete/service/restv1/campaign/{entry_id}/comment/{comment_id}/comment-action/{comment_action_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/comment/{comment\_id}/comment-action/{comment\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0,

"comment_action_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_id": 1,

"parent_comment_id": 1,

"title": "string",

"anonymous": "string",

"message": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"entry_id": 1,

"comment_person": [ ],

"total_votes_up": "string",

"total_votes_down": "string",

"total_likes": "string",

"total_dislikes": "string",

"total_favours": "string",

"total_unfavours": "string",

"logged_in_person_has_voted_up": "string",

"logged_in_person_has_voted_down": "string",

"logged_in_person_has_likes": "string",

"logged_in_person_has_dislikes": "string",

"logged_in_person_has_favours": "string",

"logged_in_person_has_unfavours": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1action1{entry_action_id}/get Get campaign action by ID

path Parameters
entry_id
required
integer
entry_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_action_id integer

Responses

200

Action

get/service/restv1/campaign/{entry_id}/action/{entry_action_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/action/{entry\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_action_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1action1{entry_action_id}/put Update campaign action by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
entry_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_action_id
required
integer
entry_action_type_id integer
person_id integer
anonymous string

Responses

200

Action updated

put/service/restv1/campaign/{entry_id}/action/{entry_action_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/action/{entry\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_action_id": 0,

"entry_action_type_id": 0,

"person_id": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entry_action_id": 1,

"entry_action_type_id": 1,

"entry_id": 1,

"person_id": 1,

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"entry_action_type": "string",

"entry_action_person": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1action1{entry_action_id}/delete Delete campaign action by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
entry_action_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_action_id
required
integer

Responses

200

Action deleted

delete/service/restv1/campaign/{entry_id}/action/{entry_action_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/action/{entry\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_action_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entry_action_id": 1,

"entry_action_type_id": 1,

"entry_id": 1,

"person_id": 1,

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"entry_action_type": "string",

"entry_action_person": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1revision1{entry_revision_id}/get Get campaign revision by ID

path Parameters
entry_id
required
integer
entry_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_revision_id integer

Responses

200

Revision

get/service/restv1/campaign/{entry_id}/revision/{entry_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/revision/{entry\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/campaigns/paths/1service1restv11campaign1{entry_id}1revision1{entry_revision_id}/put Update campaign revision by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
entry_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_revision_id
required
integer
entry_id
required
integer
name string
description string
blurb string
created string
modified string

Responses

200

Revision updated

put/service/restv1/campaign/{entry_id}/revision/{entry_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/revision/{entry\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_revision_id": 0,

"entry_id": 0,

"name": "string",

"description": "string",

"blurb": "string",

"created": "string",

"modified": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"manager_first_name": "string",

"manager_last_name": "string",

"entry_revision_id": 1,

"entry_id": 1,

"name": "string",

"blurb": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{entry_id}1revision1{entry_revision_id}/delete Delete campaign revision by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
entry_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_revision_id
required
integer
entry_id
required
integer

Responses

200

Revision deleted

delete/service/restv1/campaign/{entry_id}/revision/{entry_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/revision/{entry\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_revision_id": 0,

"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"manager_first_name": "string",

"manager_last_name": "string",

"entry_revision_id": 1,

"entry_id": 1,

"name": "string",

"blurb": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign-group1{group_id}/get Get campaign group by ID

path Parameters
group_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
group_id string

Responses

200

Group

get/service/restv1/campaign-group/{group_id}

https://www.thrinacia.com/service/restv1/campaign-group/{group\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"group_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign-group1{group_id}/put Update campaign group

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
group_id
required
string
name
required
string
description string

Responses

200

Group updated

put/service/restv1/campaign-group/{group_id}

https://www.thrinacia.com/service/restv1/campaign-group/{group\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"group_id": "string",

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string"

}`

tag/campaigns/paths/1service1restv11campaign-group1{group_id}/delete Delete campaign group

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
group_id
required
string

Responses

200

Group deleted

delete/service/restv1/campaign-group/{group_id}

https://www.thrinacia.com/service/restv1/campaign-group/{group\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"group_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}/put Update campaign

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
name string
description string
blurb string
funding_goal number
starts string
ends string
runtime_days integer
city_id string
category_id string
tag_id string
currency_id string
stripe_account_id string
widgetmakr_account_id string
manager_id string
entry_status_id string
raise_mode_id string
profile_type_id string
business_organization_id string
featured string
display_priority string
pledge_processing_started string
hidden string
private string
force_direct_transaction string
maximum_allowed_funds_raised number
duration_type_id string
uri_path string
skip_path_update string
use_widgetmakr string
group_id string
backer_offset string
created string
modified string

Responses

200

Campaign updated

put/service/restv1/campaign/{campaign_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"name": "string",

"description": "string",

"blurb": "string",

"funding_goal": 0,

"starts": "2019-08-24T14:15:22Z",

"ends": "2019-08-24T14:15:22Z",

"runtime_days": 0,

"city_id": "string",

"category_id": "string",

"tag_id": "string",

"currency_id": "string",

"stripe_account_id": "string",

"widgetmakr_account_id": "string",

"manager_id": "string",

"entry_status_id": "string",

"raise_mode_id": "string",

"profile_type_id": "string",

"business_organization_id": "string",

"featured": "string",

"display_priority": "string",

"pledge_processing_started": "string",

"hidden": "string",

"private": "string",

"force_direct_transaction": "string",

"maximum_allowed_funds_raised": 0,

"duration_type_id": "string",

"uri_path": "string",

"skip_path_update": "string",

"use_widgetmakr": "string",

"group_id": "string",

"backer_offset": "string",

"created": "string",

"modified": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"widgetmakr_cmdi_person_id": 1,

"person_id": 1,

"pid": "string",

"tracking_number": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}/delete Delete campaign

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer

Responses

200

Campaign deleted

delete/service/restv1/campaign/{campaign_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"entry_id": 1,

"entry_status_id": 1,

"raise_mode_id": 1,

"profile_type_id": 1,

"currency_id": 1,

"duration_type_id": 1,

"name": "string",

"blurb": "string",

"description": "string",

"challenge": "string",

"funding_goal": "string",

"funded_amount": 10,

"maximum_allowed_funds_raised": "string",

"maximum_allowed_pledge": "string",

"payment_threshold": "string",

"starts": "string",

"ends": "string",

"runtime_days": "string",

"ever_published": "string",

"pledge_processing_started": "string",

"featured": "string",

"display_priority": "string",

"hidden": "string",

"private": "string",

"backer_offset": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"timezone": "string",

"timezone_abbrev": "string",

"starts_date_time": "string",

"ends_date_time": "string",

"id": "string",

"entry_status": "string",

"campaign_duration": "string",

"time_remaining": "string",

"days_remaining": "string",

"hours_remaining": "string",

"minutes_remaining": "string",

"seconds_remaining": "string",

"days_remaining_inclusive": "string",

"hours_remaining_inclusive": "string",

"minutes_remaining_inclusive": "string",

"seconds_remaining_inclusive": "string",

"days_elapsed": "string",

"hours_elapsed": "string",

"minutes_elapsed": "string",

"seconds_elapsed": "string",

"days_elapsed_inclusive": "string",

"hours_elapsed_inclusive": "string",

"minutes_elapsed_inclusive": "string",

"seconds_elapsed_inclusive": "string",

"campaign_started": "string",

"total_vote_up": "string",

"total_vote_down": "string",

"total_like": "string",

"total_dislike": "string",

"total_favour": "string",

"total_unfavour": "string",

"total_vote_diff": "string",

"total_like_diff": "string",

"total_favour_diff": "string",

"entry_fee_percentage": "string",

"entry_custom_status": "string",

"funded_percentage": "string",

"uri_paths": [ ],

"categories": [ ],

"cities": [ ],

"files": [ ],

"links": [ ],

"managers": [ ],

"currencies": [ ],

"pledges": [ ],

"business_organizations": [ ],

"faqs": [ ],

"settings": [ ],

"groups": [ ],

"total_shipping_cost": "string",

"funded_amount_shipping_excluded": "string",

"funded_percentage_shipping_excluded": "string",

"total_backers": "string",

"charity_helper_amount_total": 10

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1pledge-level1{pledge_level_id}/put Update pledge level

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Pledge level updated

put/service/restv1/campaign/{campaign_id}/pledge-level/{pledge_level_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/pledge-level/{pledge\_level\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"name": "string",

"description": "string",

"amount": 0,

"estimated_delivery_time": "2019-08-24T14:15:22Z",

"item_limit": 0,

"attributes": "string",

"expires": "2019-08-24T14:15:22Z",

"coupon_id": 0,

"priority": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"pledge_level_id": 1,

"name": "string",

"description": "string",

"amount": "string",

"maximum_amount": 10,

"estimated_delivery_time": "string",

"item_limit": "string",

"attributes": "string",

"expires": "string",

"priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"entry_pledge_level_id": 1,

"coupon_id": 1,

"shipping": [ ],

"coupon": [ ],

"currencies": [ ],

"total_pledges": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1pledge-level1{pledge_level_id}/delete Delete pledge level

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer

Responses

200

Pledge level deleted

delete/service/restv1/campaign/{campaign_id}/pledge-level/{pledge_level_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/pledge-level/{pledge\_level\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"pledge_level_id": 1,

"name": "string",

"description": "string",

"amount": "string",

"maximum_amount": 10,

"estimated_delivery_time": "string",

"item_limit": "string",

"attributes": "string",

"expires": "string",

"priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"entry_pledge_level_id": 1,

"coupon_id": 1,

"shipping": [ ],

"coupon": [ ],

"currencies": [ ],

"total_pledges": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1pledge-level1{pledge_level_id}1shipping-option1{shipping_option_id}/put Update pledge level shipping option

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Shipping option updated

put/service/restv1/campaign/{campaign_id}/pledge-level/{pledge_level_id}/shipping-option/{shipping_option_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/pledge-level/{pledge\_level\_id}/shipping-option/{shipping\_option\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"shipping_option_id": 0,

"shipping_option_type_id": 0,

"country_id": 0,

"subcountry_id": 0,

"name": "string",

"description": "string",

"cost": 0,

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"shipping_option_id": 1,

"shipping_option_type_id": 1,

"country_id": 1,

"subcountry_id": 1,

"name": "string",

"description": "string",

"cost": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country": "string",

"country_code_iso3166_1": "string",

"subcountry": "string",

"subcountry_code_iso3166_2": "string",

"shipping_option_type": "string",

"country_native_name": "string",

"subcountry_native_name": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1pledge-level1{pledge_level_id}1shipping-option1{shipping_option_id}/delete Delete pledge level shipping option

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer

Responses

200

Shipping option deleted

delete/service/restv1/campaign/{campaign_id}/pledge-level/{pledge_level_id}/shipping-option/{shipping_option_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/pledge-level/{pledge\_level\_id}/shipping-option/{shipping\_option\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"shipping_option_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"shipping_option_id": 1,

"shipping_option_type_id": 1,

"country_id": 1,

"subcountry_id": 1,

"name": "string",

"description": "string",

"cost": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country": "string",

"country_code_iso3166_1": "string",

"subcountry": "string",

"subcountry_code_iso3166_2": "string",

"shipping_option_type": "string",

"country_native_name": "string",

"subcountry_native_name": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1resource1{resource_type}/post Create campaign resource

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required

Responses

200

Resource created

post/service/restv1/campaign/{campaign_id}/resource/{resource_type}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1resource1{resource_type}~1{resource_id}/put Update campaign resource

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required

Responses

200

Resource updated

put/service/restv1/campaign/{campaign_id}/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1resource1{resource_type}~1{resource_id}/delete Delete campaign resource

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Resource deleted

delete/service/restv1/campaign/{campaign_id}/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1resource-revision1{resource_type?}/post Create campaign resource revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Resource revision created

post/service/restv1/campaign/{campaign_id}/resource-revision/{resource_type?}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/resource-revision/{resource\_type?}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"region_id": "string",

"label": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_revision_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_revision_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1resource-revision1{resource_type?}~1{resource_revision_id?}/put Update campaign resource revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Resource revision updated

put/service/restv1/campaign/{campaign_id}/resource-revision/{resource_type?}/{resource_revision_id?}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/resource-revision/{resource\_type?}/{resource\_revision\_id?}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"resource_revision_id": "string",

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"region_id": "string",

"label": "string",

"file_sync": "string",

"file_sync_resource_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_revision_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_file_revision_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1resource-revision1{resource_revision_id}/delete Delete campaign resource revision by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
resource_type
required
string
resource_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
resource_revision_id
required
string
resource_type
required
string

Responses

200

Resource revision deleted

delete/service/restv1/campaign/{campaign_id}/resource-revision/{resource_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/resource-revision/{resource\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"resource_revision_id": "string",

"resource_type": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"html_revision_id": 1,

"html": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_html_revision_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq1{faq_id}/put Update campaign FAQ

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer
name
required
string
description string

Responses

200

FAQ updated

put/service/restv1/campaign/{campaign_id}/faq/{faq_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq/{faq\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq1{faq_id}/delete Delete campaign FAQ

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer

Responses

200

FAQ deleted

delete/service/restv1/campaign/{campaign_id}/faq/{faq_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq/{faq\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq1{faq_id}1faq-pair1{faq_pair_id}/put Update campaign FAQ pair

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

FAQ pair updated

put/service/restv1/campaign/{campaign_id}/faq/{faq_id}/faq-pair/{faq_pair_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq/{faq\_id}/faq-pair/{faq\_pair\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"faq_pair_id": 0,

"question": "string",

"answer": "string",

"display_priority": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"faq_pair_id": 1,

"faq_id": 1,

"question": "string",

"answer": "string",

"display_priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq1{faq_id}1faq-pair1{faq_pair_id}/delete Delete campaign FAQ pair

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer

Responses

200

FAQ pair deleted

delete/service/restv1/campaign/{campaign_id}/faq/{faq_id}/faq-pair/{faq_pair_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq/{faq\_id}/faq-pair/{faq\_pair\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"faq_pair_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"faq_pair_id": 1,

"faq_id": 1,

"question": "string",

"answer": "string",

"display_priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq-revision1{faq_revision_id}/put Update FAQ revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer
name
required
string
description string

Responses

200

FAQ revision updated

put/service/restv1/campaign/{campaign_id}/faq-revision/{faq_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq-revision/{faq\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_revision_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq-revision1{faq_revision_id}/delete Delete FAQ revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer

Responses

200

FAQ revision deleted

delete/service/restv1/campaign/{campaign_id}/faq-revision/{faq_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq-revision/{faq\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"faq_revision_id": 1,

"name": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"faq_pairs": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq-revision1{faq_revision_id}1faq-pair-revision1{faq_pair_revision_id}/put Update FAQ pair revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

FAQ pair revision updated

put/service/restv1/campaign/{campaign_id}/faq-revision/{faq_revision_id}/faq-pair-revision/{faq_pair_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq-revision/{faq\_revision\_id}/faq-pair-revision/{faq\_pair\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"faq_pair_revision_id": 0,

"question": "string",

"answer": "string",

"display_priority": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"faq_pair_revision_id": 1,

"faq_revision_id": 1,

"question": "string",

"answer": "string",

"display_priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq-revision1{faq_revision_id}1faq-pair-revision1{faq_pair_revision_id}/delete Delete FAQ pair revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer

Responses

200

FAQ pair revision deleted

delete/service/restv1/campaign/{campaign_id}/faq-revision/{faq_revision_id}/faq-pair-revision/{faq_pair_revision_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq-revision/{faq\_revision\_id}/faq-pair-revision/{faq\_pair\_revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"faq_pair_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"faq_pair_revision_id": 1,

"faq_revision_id": 1,

"question": "string",

"answer": "string",

"display_priority": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1note1{note_id}/put Update campaign note

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_note_id
required
integer
value
required
string

Responses

200

Note updated

put/service/restv1/campaign/{campaign_id}/note/{note_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/note/{note\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_note_id": 0,

"value": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_note_id": 1,

"entry_id": 1,

"value": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1note1{note_id}/delete Delete campaign note

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_note_id
required
integer

Responses

200

Note deleted

delete/service/restv1/campaign/{campaign_id}/note/{note_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/note/{note\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_note_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_note_id": 1,

"entry_id": 1,

"value": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1stream1{stream_id}/put Update campaign stream entry

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Stream entry updated

put/service/restv1/campaign/{campaign_id}/stream/{stream_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/stream/{stream\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stream_id": 0,

"stream_type_id": 0,

"entry_id": 0,

"person_id": "string",

"title": "string",

"message": "string",

"published": "string",

"display_priority": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"stream_id": 1,

"stream_type_id": 1,

"entry_id": 1,

"title": "string",

"message": "string",

"display_priority": "string",

"published": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"stream_type": "string",

"stream_backers": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1stream1{stream_id}/delete Delete campaign stream entry

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stream_id
required
integer
entry_id
required
integer

Responses

200

Stream entry deleted

delete/service/restv1/campaign/{campaign_id}/stream/{stream_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/stream/{stream\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stream_id": 0,

"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"stream_id": 1,

"stream_type_id": 1,

"entry_id": 1,

"title": "string",

"message": "string",

"display_priority": "string",

"published": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"stream_type": "string",

"stream_backers": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1comment1{comment_id}/put Update campaign comment

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Comment updated

put/service/restv1/campaign/{campaign_id}/comment/{comment_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/comment/{comment\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"person_id": 0,

"comment_id": 0,

"title": "string",

"anonymous": "string",

"message": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_id": 1,

"parent_comment_id": 1,

"title": "string",

"anonymous": "string",

"message": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"entry_id": 1,

"comment_person": [ ],

"total_votes_up": "string",

"total_votes_down": "string",

"total_likes": "string",

"total_dislikes": "string",

"total_favours": "string",

"total_unfavours": "string",

"logged_in_person_has_voted_up": "string",

"logged_in_person_has_voted_down": "string",

"logged_in_person_has_likes": "string",

"logged_in_person_has_dislikes": "string",

"logged_in_person_has_favours": "string",

"logged_in_person_has_unfavours": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1comment1{comment_id}/delete Delete campaign comment

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id
required
integer

Responses

200

Comment deleted

delete/service/restv1/campaign/{campaign_id}/comment/{comment_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/comment/{comment\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_id": 1,

"parent_comment_id": 1,

"title": "string",

"anonymous": "string",

"message": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"entry_id": 1,

"comment_person": [ ],

"total_votes_up": "string",

"total_votes_down": "string",

"total_likes": "string",

"total_dislikes": "string",

"total_favours": "string",

"total_unfavours": "string",

"logged_in_person_has_voted_up": "string",

"logged_in_person_has_voted_down": "string",

"logged_in_person_has_likes": "string",

"logged_in_person_has_dislikes": "string",

"logged_in_person_has_favours": "string",

"logged_in_person_has_unfavours": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1comment1{comment_id}1comment-action1{comment_action_id}/put Update comment action

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Comment action updated

put/service/restv1/campaign/{campaign_id}/comment/{comment_id}/comment-action/{comment_action_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/comment/{comment\_id}/comment-action/{comment\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0,

"comment_action_id": 0,

"comment_action_type_id": 0,

"person_id": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_action_id": 1,

"comment_action_type_id": 1,

"comment_id": 1,

"person_id": 1,

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"comment_action_type": "string",

"comment_action_person": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1comment1{comment_id}1comment-action1{comment_action_id}/delete Delete comment action

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer

Responses

200

Comment action deleted

delete/service/restv1/campaign/{campaign_id}/comment/{comment_id}/comment-action/{comment_action_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/comment/{comment\_id}/comment-action/{comment\_action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"comment_id": 0,

"comment_action_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"comment_id": 1,

"parent_comment_id": 1,

"title": "string",

"anonymous": "string",

"message": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"person_id": 1,

"entry_id": 1,

"comment_person": [ ],

"total_votes_up": "string",

"total_votes_down": "string",

"total_likes": "string",

"total_dislikes": "string",

"total_favours": "string",

"total_unfavours": "string",

"logged_in_person_has_voted_up": "string",

"logged_in_person_has_voted_down": "string",

"logged_in_person_has_likes": "string",

"logged_in_person_has_dislikes": "string",

"logged_in_person_has_favours": "string",

"logged_in_person_has_unfavours": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1action1{action_id}/put Update campaign action

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Action updated

put/service/restv1/campaign/{campaign_id}/action/{action_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/action/{action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_action_id": 0,

"entry_action_type_id": 0,

"person_id": 0,

"anonymous": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entry_action_id": 1,

"entry_action_type_id": 1,

"entry_id": 1,

"person_id": 1,

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"entry_action_type": "string",

"entry_action_person": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1action1{action_id}/delete Delete campaign action

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_action_id
required
integer

Responses

200

Action deleted

delete/service/restv1/campaign/{campaign_id}/action/{action_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/action/{action\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_action_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entry_action_id": 1,

"entry_action_type_id": 1,

"entry_id": 1,

"person_id": 1,

"anonymous": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"entry_action_type": "string",

"entry_action_person": [ ]

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1revision1{revision_id}/put Update campaign revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Revision updated

put/service/restv1/campaign/{campaign_id}/revision/{revision_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/revision/{revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_revision_id": 0,

"entry_id": 0,

"name": "string",

"description": "string",

"blurb": "string",

"created": "string",

"modified": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"manager_first_name": "string",

"manager_last_name": "string",

"entry_revision_id": 1,

"entry_id": 1,

"name": "string",

"blurb": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1revision1{revision_id}/delete Delete campaign revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_revision_id
required
integer
entry_id
required
integer

Responses

200

Revision deleted

delete/service/restv1/campaign/{campaign_id}/revision/{revision_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/revision/{revision\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_revision_id": 0,

"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"manager_first_name": "string",

"manager_last_name": "string",

"entry_revision_id": 1,

"entry_id": 1,

"name": "string",

"blurb": "string",

"description": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq1{faq_id}~1faq-pair/post Create campaign FAQ pair

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_id
required
integer
pairs
required
string

Responses

200

FAQ pair created

post/service/restv1/campaign/{campaign_id}/faq/{faq_id}/faq-pair

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq/{faq\_id}/faq-pair

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_id": 0,

"pairs": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"faq_pair_id": 1,\ \ "faq_id": 1,\ \ "question": "string",\ \ "answer": "string",\ \ "display_priority": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1faq-revision1{faq_revision_id}~1faq-pair-revision/post Create FAQ pair revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
faq_revision_id
required
integer
pairs
required
string

Responses

200

FAQ pair revision created

post/service/restv1/campaign/{campaign_id}/faq-revision/{faq_revision_id}/faq-pair-revision

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/faq-revision/{faq\_revision\_id}/faq-pair-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"faq_revision_id": 0,

"pairs": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"faq_pair_revision_id": 1,\ \ "faq_revision_id": 1,\ \ "question": "string",\ \ "answer": "string",\ \ "display_priority": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{campaign_id}~1stats/get Get campaign stats

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
summary integer
use_widgetmakr integer

Responses

200

Campaign stats

get/service/restv1/campaign/{campaign_id}/stats

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/stats

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"summary": 0,

"use_widgetmakr": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"stripe_transaction_id": 1,

"stripe_transaction_status_id": 1,

"stripe_transaction_type_id": 1,

"nr_of_tries": "string",

"last_executed": "string",

"reference_no": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"anonymous_contribution": "string",

"anonymous_contribution_partial": "string",

"stripe_transaction_type": "string",

"stripe_transaction_status": "string",

"card": [ ],

"backer": [ ],

"coupon": [ ],

"fulfillment_status": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}~1setting/put Update campaign settings

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
public string

Responses

200

Settings updated

put/service/restv1/campaign/{campaign_id}/setting

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"public": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"setting_id": 1,

"setting_type_id": 1,

"name": "string",

"value": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}~1setting/get Get campaign setting by key

path Parameters
entry_id
required
integer
setting
required
string

Responses

200

Setting

get/service/restv1/campaign/{campaign_id}/setting

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/setting

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"setting_id": 1,\ \ "setting_type_id": 1,\ \ "name": "string",\ \ "value": "string",\ \ "description": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{campaign_id}~1setting-revision/put Update campaign setting revision

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileSettingRevisionUpdateRequest)

Responses

200

Setting revision updated

put/service/restv1/campaign/{campaign_id}/setting-revision

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/setting-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"setting_revision_id": 1,

"setting_type_id": 1,

"name": "string",

"value": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"entry_setting_revision_id": 1,

"entry_id": 1,

"id": "string"

}`

tag/campaigns/paths/1service1restv11campaign1{campaign_id}~1setting-revision/get Get campaign setting revision by key

path Parameters
entry_id
required
integer
setting
required
string

Responses

200

Setting revision

get/service/restv1/campaign/{campaign_id}/setting-revision

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/setting-revision

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"setting_revision_id": 1,\ \ "setting_type_id": 1,\ \ "name": "string",\ \ "value": "string",\ \ "description": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "entry_setting_revision_id": 1,\ \ "entry_id": 1,\ \ "id": "string"\ \ }\ \ ]

tag/campaigns/paths/1service1restv11campaign1{campaign_id}~1widget/get Get campaign widget

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
src string
preview string
themecolor string
backersfontcolor string
blurbfontcolor string
campaignfontcolor string
commentsfontcolor string
contactfontcolor string
creatorfontcolor string
faqfontcolor string
fundingfontcolor string
paymentfontcolor string
profilefontcolor string
rewardsfontcolor string
streamsfontcolor string
tabbackgroundcolor string
tabselectedfontcolor string
tabunselectedfontcolor string
topfontcolor string
fontfamily string

Responses

200

Widget HTML

get/service/restv1/campaign/{campaign_id}/widget

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/widget

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"src": "string",

"preview": "string",

"themecolor": "string",

"backersfontcolor": "string",

"blurbfontcolor": "string",

"campaignfontcolor": "string",

"commentsfontcolor": "string",

"contactfontcolor": "string",

"creatorfontcolor": "string",

"faqfontcolor": "string",

"fundingfontcolor": "string",

"paymentfontcolor": "string",

"profilefontcolor": "string",

"rewardsfontcolor": "string",

"streamsfontcolor": "string",

"tabbackgroundcolor": "string",

"tabselectedfontcolor": "string",

"tabunselectedfontcolor": "string",

"topfontcolor": "string",

"fontfamily": "string"

}`

Response samples

  • 200

Content type

text/html

Copy

<html><body>Widget</body></html>

tag/campaigns/paths/1service1restv11campaign1{campaign_id}1resource-revision1{resource_revision_id?}/get Get campaign resource revision by ID

path Parameters
entry_id
required
integer
resource_type
required
string
resource_revision_id
required
integer

Responses

200

Resource revision

get/service/restv1/campaign/{campaign_id}/resource-revision/{resource_revision_id?}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/resource-revision/{resource\_revision\_id?}

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"html_revision_id": 1,

"html": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"entry_html_revision_id": 1,

"region_name": "string",

"region_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1

}`

tag/donations donations

tag/donations/paths/1service1restv11campaign1{entry_id}1pledge1manual/post Create manual pledge

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
person_id
required
integer
pledge_level_id integer
business_organization_id string
amount
required
number
amount_tip number
force_tip_processing string
anonymous_contribution string
anonymous_contribution_partial string
shipping_address_id integer
phone_number_id integer
use_widgetmakr string
email_notify string
reference_no string
created string
modified string
skip_threshold_verification string
note string
coupon_code string

Responses

200

Pledge created

post/service/restv1/campaign/{entry_id}/pledge/manual

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge/manual

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"person_id": 0,

"pledge_level_id": 0,

"business_organization_id": "string",

"amount": 0,

"amount_tip": 0,

"force_tip_processing": "string",

"anonymous_contribution": "string",

"anonymous_contribution_partial": "string",

"shipping_address_id": 0,

"phone_number_id": 0,

"use_widgetmakr": "string",

"email_notify": "string",

"reference_no": "string",

"created": "string",

"modified": "string",

"skip_threshold_verification": "string",

"note": "string",

"coupon_code": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"card_id": 1,

"user_id": 1

}`

tag/donations/paths/1service1restv11campaign1{entry_id}1pledge1guest/post Create guest pledge

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
pledge_level_id integer
business_organization_id string
amount
required
number
amount_tip number
force_tip_processing string
shipping_address_id integer
phone_number_id integer
card_id
required
string
fingerprint
required
string
use_widgetmakr string
email
required
string
attributes string
first_name string
last_name string
note string
coupon_code string
use_sca string

Responses

200

Guest pledge created

post/service/restv1/campaign/{entry_id}/pledge/guest

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge/guest

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"pledge_level_id": 0,

"business_organization_id": "string",

"amount": 0,

"amount_tip": 0,

"force_tip_processing": "string",

"shipping_address_id": 0,

"phone_number_id": 0,

"card_id": "string",

"fingerprint": "string",

"use_widgetmakr": "string",

"email": "user@example.com",

"attributes": "string",

"first_name": "string",

"last_name": "string",

"note": "string",

"coupon_code": "string",

"use_sca": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"card_id": 1,

"user_id": 1

}`

tag/donations/paths/1service1restv11campaign1{entry_id}~1pledge/get Get pledges

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_backer_id integer
inline_token string

Responses

200

Pledge list

get/service/restv1/campaign/{entry_id}/pledge

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_backer_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "entry_backer_id": 1,\ \ "entry_id": 1,\ \ "person_id": 1,\ \ "entry_pledge_level_id": 1,\ \ "shipping_address_id": 1,\ \ "phone_number_id": 1,\ \ "stripe_recurring_subscription_id": 1,\ \ "business_organization_id": 1,\ \ "coupon_id": 1,\ \ "amount": "string",\ \ "amount_tip": "string",\ \ "force_tip_processing": "string",\ \ "charity_helper_amount": 10,\ \ "anonymous_contribution": "string",\ \ "anonymous_contribution_partial": "string",\ \ "attributes": "string",\ \ "note": "string",\ \ "quantity": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "raise_mode_id": 1,\ \ "payment_intent_client_secret": "string",\ \ "payment_intent_client_secret_tip": "string",\ \ "charge_id": 1,\ \ "charge_id_tip": "string",\ \ "stripe_transaction_id": 1,\ \ "payment_intent_status": "string",\ \ "payment_intent_status_tip": "string",\ \ "setup_intent_client_secret": "string",\ \ "setup_intent_status": "string",\ \ "pledge_levels": [ ]\ \ }\ \ ]

tag/donations/paths/1service1restv11campaign1{entry_id}~1pledge/post Create pledge

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
stripe_account_card_id integer
widgetmakr_account_card_id integer
pledge_level_id integer
business_organization_id string
amount number
amount_tip number
force_tip_processing string
anonymous_contribution string
anonymous_contribution_partial string
shipping_address_id integer
phone_number_id integer
inline_token string
email string
attributes string
charity_helper integer
note string
coupon_code string
use_sca string

Responses

200

Pledge created

post/service/restv1/campaign/{entry_id}/pledge

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"stripe_account_card_id": 0,

"widgetmakr_account_card_id": 0,

"pledge_level_id": 0,

"business_organization_id": "string",

"amount": 0,

"amount_tip": 0,

"force_tip_processing": "string",

"anonymous_contribution": "string",

"anonymous_contribution_partial": "string",

"shipping_address_id": 0,

"phone_number_id": 0,

"inline_token": "string",

"email": "user@example.com",

"attributes": "string",

"charity_helper": 0,

"note": "string",

"coupon_code": "string",

"use_sca": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"entry_backer_id": 1,

"entry_id": 1,

"person_id": 1,

"entry_pledge_level_id": 1,

"shipping_address_id": 1,

"phone_number_id": 1,

"stripe_recurring_subscription_id": 1,

"business_organization_id": 1,

"coupon_id": 1,

"amount": "string",

"amount_tip": "string",

"force_tip_processing": "string",

"charity_helper_amount": 10,

"anonymous_contribution": "string",

"anonymous_contribution_partial": "string",

"attributes": "string",

"note": "string",

"quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"raise_mode_id": 1,

"payment_intent_client_secret": "string",

"payment_intent_client_secret_tip": "string",

"charge_id": 1,

"charge_id_tip": "string",

"stripe_transaction_id": 1,

"payment_intent_status": "string",

"payment_intent_status_tip": "string",

"setup_intent_client_secret": "string",

"setup_intent_status": "string",

"pledge_levels": [ ]

}`

tag/donations/paths/1service1restv11campaign1{entry_id}~1backer/get Get campaign backers

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_backer_id integer
filters string

Responses

200

Backer list

get/service/restv1/campaign/{entry_id}/backer

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/backer

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_backer_id": 0,

"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"entry_id": 1,\ \ "total_amount": 10,\ \ "backer_disabled": "string",\ \ "anonymous_contribution": [ ],\ \ "anonymous_contribution_partial": [ ],\ \ "id": "string",\ \ "person_id": 1,\ \ "first_name": [ ],\ \ "last_name": [ ],\ \ "total_backed": "string",\ \ "person_addresses": [ ],\ \ "person_websites": [ ],\ \ "person_files": [ ],\ \ "notes": [ ]\ \ }\ \ ]

tag/donations/paths/1service1restv11campaign1{entry_id}~1pledge-transaction/get Get pledge transactions

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_transaction_entry_backer_id integer

Responses

200

Pledge transaction list

get/service/restv1/campaign/{entry_id}/pledge-transaction

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-transaction

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_transaction_entry_backer_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "paypal_transaction_id": 1,\ \ "paypal_transaction_status_id": 1,\ \ "paypal_transaction_type_id": 1,\ \ "charge_id": 1,\ \ "charge_id_tip": "string",\ \ "payment_intent_client_secret": "string",\ \ "payment_intent_client_secret_tip": "string",\ \ "payment_intent_status": "string",\ \ "payment_intent_status_tip": "string",\ \ "setup_intent_client_secret": "string",\ \ "setup_intent_status": "string",\ \ "reference_no": "string",\ \ "use_sca": "string",\ \ "nr_of_tries": "string",\ \ "last_executed": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true,\ \ "paypal_transaction_type": "string",\ \ "paypal_transaction_status": "string",\ \ "entry_backer_id": 1,\ \ "entry_id": 1,\ \ "person_id": 1,\ \ "entry_pledge_level_id": 1,\ \ "shipping_address_id": 1,\ \ "phone_number_id": 1,\ \ "stripe_recurring_subscription_id": 1,\ \ "business_organization_id": 1,\ \ "coupon_id": 1,\ \ "amount": "string",\ \ "amount_tip": "string",\ \ "force_tip_processing": "string",\ \ "charity_helper_amount": 10,\ \ "anonymous_contribution": "string",\ \ "anonymous_contribution_partial": "string",\ \ "attributes": "string",\ \ "note": "string",\ \ "quantity": "string",\ \ "email": "user@example.com",\ \ "campaign": "string",\ \ "pledge_level_id": 1,\ \ "pledge_amount": 10,\ \ "pledge_level_name": "string",\ \ "pledge_level_description": "string",\ \ "pledge_level_amount": 10,\ \ "currency": "string",\ \ "paypal_account_card_id": 1,\ \ "card_id": 1,\ \ "last4": "string",\ \ "exp_month": "string",\ \ "exp_year": "string",\ \ "user_id": 1,\ \ "fulfillment_status": "string"\ \ }\ \ ]

tag/donations/paths/1image1want_pledge_history/get Pledge history image

Responses

200

Image

get/image/want_pledge_history

https://www.thrinacia.com/image/want\_pledge\_history

Response samples

  • 200

Content type

image/*

Copy

string

tag/donations/paths/1service1restv11campaign1{entry_id}1pledge1{entry_backer_id}/get Get pledge by ID

path Parameters
entry_id
required
integer
entry_backer_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_backer_id integer
inline_token string

Responses

200

Pledge

get/service/restv1/campaign/{entry_id}/pledge/{entry_backer_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge/{entry\_backer\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_backer_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/donations/paths/1service1restv11campaign1{entry_id}1pledge1{entry_backer_id}/put Update pledge by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
entry_backer_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_backer_id
required
integer
stripe_account_card_id integer
pledge_level_id integer
business_organization_id string
amount
required
number
amount_tip number
force_tip_processing string
anonymous_contribution string
anonymous_contribution_partial string
attributes string
note string
shipping_address_id integer
phone_number_id integer
inline_token string
charity_helper integer
coupon_code string
use_sca string

Responses

200

Pledge updated

put/service/restv1/campaign/{entry_id}/pledge/{entry_backer_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge/{entry\_backer\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_backer_id": 0,

"stripe_account_card_id": 0,

"pledge_level_id": 0,

"business_organization_id": "string",

"amount": 0,

"amount_tip": 0,

"force_tip_processing": "string",

"anonymous_contribution": "string",

"anonymous_contribution_partial": "string",

"attributes": "string",

"note": "string",

"shipping_address_id": 0,

"phone_number_id": 0,

"inline_token": "string",

"charity_helper": 0,

"coupon_code": "string",

"use_sca": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_backer_id": 1,

"entry_id": 1,

"person_id": 1,

"entry_pledge_level_id": 1,

"shipping_address_id": 1,

"phone_number_id": 1,

"stripe_recurring_subscription_id": 1,

"business_organization_id": 1,

"coupon_id": 1,

"amount": "string",

"amount_tip": "string",

"force_tip_processing": "string",

"charity_helper_amount": 10,

"anonymous_contribution": "string",

"anonymous_contribution_partial": "string",

"attributes": "string",

"note": "string",

"quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/donations/paths/1service1restv11campaign1{entry_id}1pledge1{entry_backer_id}/delete Delete pledge by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
entry_backer_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_backer_id
required
integer
inline_token string

Responses

200

Pledge deleted

delete/service/restv1/campaign/{entry_id}/pledge/{entry_backer_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge/{entry\_backer\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_backer_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_transaction_entry_backer_id": 1,

"stripe_transaction_id": 1,

"stripe_account_card_id": 1,

"entry_backer_id": 1,

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/donations/paths/1service1restv11campaign1{entry_id}1pledge-transaction1{stripe_transaction_entry_backer_id}/get Get pledge transaction by ID

path Parameters
entry_id
required
integer
stripe_transaction_entry_backer_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_transaction_entry_backer_id integer

Responses

200

Transaction

get/service/restv1/campaign/{entry_id}/pledge-transaction/{stripe_transaction_entry_backer_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-transaction/{stripe\_transaction\_entry\_backer\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_transaction_entry_backer_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "stripe_transaction_id": 1,\ \ "stripe_transaction_status_id": 1,\ \ "stripe_transaction_type_id": 1,\ \ "charge_id": 1,\ \ "charge_id_tip": "string",\ \ "payment_intent_client_secret": "string",\ \ "payment_intent_client_secret_tip": "string",\ \ "payment_intent_status": "string",\ \ "payment_intent_status_tip": "string",\ \ "setup_intent_client_secret": "string",\ \ "setup_intent_status": "string",\ \ "reference_no": "string",\ \ "use_sca": "string",\ \ "nr_of_tries": "string",\ \ "last_executed": "string",\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z",\ \ "disabled": true,\ \ "stripe_transaction_type": "string",\ \ "stripe_transaction_status": "string",\ \ "entry_backer_id": 1,\ \ "entry_id": 1,\ \ "person_id": 1,\ \ "entry_pledge_level_id": 1,\ \ "shipping_address_id": 1,\ \ "phone_number_id": 1,\ \ "stripe_recurring_subscription_id": 1,\ \ "business_organization_id": 1,\ \ "coupon_id": 1,\ \ "amount": "string",\ \ "amount_tip": "string",\ \ "force_tip_processing": "string",\ \ "charity_helper_amount": 10,\ \ "anonymous_contribution": "string",\ \ "anonymous_contribution_partial": "string",\ \ "attributes": "string",\ \ "note": "string",\ \ "quantity": "string",\ \ "email": "user@example.com",\ \ "campaign": "string",\ \ "pledge_level_id": 1,\ \ "pledge_amount": 10,\ \ "pledge_level_name": "string",\ \ "pledge_level_description": "string",\ \ "pledge_level_amount": 10,\ \ "stripe_account_card_id": 1,\ \ "card_id": 1,\ \ "last4": "string",\ \ "exp_month": "string",\ \ "exp_year": "string",\ \ "fulfillment_status": "string"\ \ }\ \ ]

tag/donations/paths/1service1restv11campaign1{entry_id}1pledge-transaction1{stripe_transaction_entry_backer_id}/put Update pledge transaction by ID

path Parameters
entry_id
required
integer
stripe_transaction_entry_backer_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_transaction_entry_backer_id
required
integer
stripe_account_card_id integer
stripe_account_card_id_previous integer
use_sca string
sca_confirm_intent_capture string
retry_pledge_token string
amount_tip number

Responses

200

Transaction updated

put/service/restv1/campaign/{entry_id}/pledge-transaction/{stripe_transaction_entry_backer_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-transaction/{stripe\_transaction\_entry\_backer\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_transaction_entry_backer_id": 0,

"stripe_account_card_id": 0,

"stripe_account_card_id_previous": 0,

"use_sca": "string",

"sca_confirm_intent_capture": "string",

"retry_pledge_token": "string",

"amount_tip": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_transaction_entry_backer_id": 1,

"stripe_transaction_id": 1,

"stripe_account_card_id": 1,

"entry_backer_id": 1,

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/donations/paths/1service1restv11campaign1{campaign_id}1pledge1{pledge_id}/put Update pledge

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Pledge updated

put/service/restv1/campaign/{campaign_id}/pledge/{pledge_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/pledge/{pledge\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_backer_id": 0,

"stripe_account_card_id": 0,

"pledge_level_id": 0,

"business_organization_id": "string",

"amount": 0,

"amount_tip": 0,

"force_tip_processing": "string",

"anonymous_contribution": "string",

"anonymous_contribution_partial": "string",

"attributes": "string",

"note": "string",

"shipping_address_id": 0,

"phone_number_id": 0,

"inline_token": "string",

"charity_helper": 0,

"coupon_code": "string",

"use_sca": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_backer_id": 1,

"entry_id": 1,

"person_id": 1,

"entry_pledge_level_id": 1,

"shipping_address_id": 1,

"phone_number_id": 1,

"stripe_recurring_subscription_id": 1,

"business_organization_id": 1,

"coupon_id": 1,

"amount": "string",

"amount_tip": "string",

"force_tip_processing": "string",

"charity_helper_amount": 10,

"anonymous_contribution": "string",

"anonymous_contribution_partial": "string",

"attributes": "string",

"note": "string",

"quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/donations/paths/1service1restv11campaign1{campaign_id}1pledge1{pledge_id}/delete Delete pledge

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
entry_backer_id
required
integer
inline_token string

Responses

200

Pledge deleted

delete/service/restv1/campaign/{campaign_id}/pledge/{pledge_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/pledge/{pledge\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"entry_backer_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_transaction_entry_backer_id": 1,

"stripe_transaction_id": 1,

"stripe_account_card_id": 1,

"entry_backer_id": 1,

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/donations/paths/1service1restv11campaign1{campaign_id}1pledge-transaction1{pledge_transaction_id}/put Update pledge transaction

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Transaction updated

put/service/restv1/campaign/{campaign_id}/pledge-transaction/{pledge_transaction_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/pledge-transaction/{pledge\_transaction\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_transaction_entry_backer_id": 0,

"stripe_account_card_id": 0,

"stripe_account_card_id_previous": 0,

"use_sca": "string",

"sca_confirm_intent_capture": "string",

"retry_pledge_token": "string",

"amount_tip": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_transaction_entry_backer_id": 1,

"stripe_transaction_id": 1,

"stripe_account_card_id": 1,

"entry_backer_id": 1,

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/payments payments

tag/payments/paths/1service1restv1~1subscription/post Create a subscription

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
token
required
string
email
required
string
first_name
required
string
last_name
required
string
street1
required
string
mail_code
required
string
city_id
required
integer
subscription_plan_id
required
integer
portal_name
required
string
create_sample_data string
secure_website string
custom_domain string
skype_id string
source string
terms
required
string
use_sca string

Responses

200

Subscription created/updated

400

Invalid request

500

Internal server error

post/service/restv1/subscription

https://www.thrinacia.com/service/restv1/subscription

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"token": "string",

"email": "user@example.com",

"first_name": "string",

"last_name": "string",

"street1": "string",

"mail_code": "string",

"city_id": 0,

"subscription_plan_id": 0,

"portal_name": "string",

"create_sample_data": "string",

"secure_website": "string",

"custom_domain": "string",

"skype_id": "string",

"source": "string",

"terms": "string",

"use_sca": "string"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy

`{"subscription_plan_id": 1,

"name": "string",

"code": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11account1stripe~1guest/post Create guest Stripe account

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
email
required
string
card_token string
number string
exp_month string
exp_year string
cvc string
first_name string
last_name string
address_line1 string
address_line2 string
address_zip string
address_state string
address_country string

Responses

200

Stripe guest account created

post/service/restv1/account/stripe/guest

https://www.thrinacia.com/service/restv1/account/stripe/guest

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"email": "string",

"card_token": "string",

"number": "string",

"exp_month": "string",

"exp_year": "string",

"cvc": "string",

"first_name": "string",

"last_name": "string",

"address_line1": "string",

"address_line2": "string",

"address_zip": "string",

"address_state": "string",

"address_country": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1stripe/post Create Stripe account

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
card_token string
number string
exp_month string
exp_year string
cvc string
inline_token string
name string
address_line1 string
address_line2 string
address_zip string
address_state string
address_country string

Responses

200

Stripe account created

post/service/restv1/account/stripe

https://www.thrinacia.com/service/restv1/account/stripe

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"card_token": "string",

"number": "string",

"exp_month": "string",

"exp_year": "string",

"cvc": "string",

"inline_token": "string",

"name": "string",

"address_line1": "string",

"address_line2": "string",

"address_zip": "string",

"address_state": "string",

"address_country": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1stripe~1application/get Get Stripe application

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileStripeApplicationRetrieveRequest)

Responses

200

Stripe application data

get/service/restv1/account/stripe/application

https://www.thrinacia.com/service/restv1/account/stripe/application

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1application/post Create Stripe application

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id
required
string
secret_key
required
string
publishable_key
required
string
country_id
required
string
client_id string
skip_user_id string

Responses

200

Stripe application created

post/service/restv1/account/stripe/application

https://www.thrinacia.com/service/restv1/account/stripe/application

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": "string",

"secret_key": "string",

"publishable_key": "string",

"country_id": "string",

"client_id": "string",

"skip_user_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1connect/post Create Stripe connect

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
code
required
string
scope string
state string
name string
description string

Responses

200

Stripe connect created

post/service/restv1/account/stripe/connect

https://www.thrinacia.com/service/restv1/account/stripe/connect

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"code": "string",

"scope": "string",

"state": "string",

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1admin-connected/get Check if admin is connected to Stripe

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileStripeAdminConnectedRequest)

Responses

200

Admin connected status

get/service/restv1/account/stripe/admin-connected

https://www.thrinacia.com/service/restv1/account/stripe/admin-connected

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_account_id": 1,

"person_id": 1,

"name": "string",

"description": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1connect-event/get Get Stripe connect event

Authorizations:

ApiTokenAuth__SessionCookie

Responses

204

No content

get/service/restv1/account/stripe/connect-event

https://www.thrinacia.com/service/restv1/account/stripe/connect-event

tag/payments/paths/1service1restv11account1stripe1{stripe_account_id}1card/get Get Stripe account card(s)

path Parameters
stripe_account_id
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id
required
string
stripe_account_card_id string
inline_token string

Responses

200

Card list

get/service/restv1/account/stripe/{stripe_account_id}/card

https://www.thrinacia.com/service/restv1/account/stripe/{stripe\_account\_id}/card

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string",

"stripe_account_card_id": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/payments/paths/1service1restv11account1stripe1{stripe_account_id}1card/post Create Stripe account card

path Parameters
stripe_account_id
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
card_token string
stripe_account_id
required
string
number string
exp_month string
exp_year string
cvc string
name string
address_line1 string
address_line2 string
address_zip string
address_state string
address_country string
inline_token string
default_card string

Responses

200

Card created

post/service/restv1/account/stripe/{stripe_account_id}/card

https://www.thrinacia.com/service/restv1/account/stripe/{stripe\_account\_id}/card

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"card_token": "string",

"stripe_account_id": "string",

"number": "string",

"exp_month": "string",

"exp_year": "string",

"cvc": "string",

"name": "string",

"address_line1": "string",

"address_line2": "string",

"address_zip": "string",

"address_state": "string",

"address_country": "string",

"inline_token": "string",

"default_card": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_account_card_id": 1,

"stripe_account_card_type_id": 1,

"stripe_account_id": 1,

"card_id": 1,

"fingerprint": "string",

"last4": "string",

"exp_month": "string",

"exp_year": "string",

"default_card": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1country/get List Stripe countries

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileStripeCountryRetrieveRequest)

Responses

200

Country list

get/service/restv1/account/stripe/country

https://www.thrinacia.com/service/restv1/account/stripe/country

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "stripe_country_id": 1\ \ }\ \ ]

tag/payments/paths/1service1restv11account1stripe~1currency/get List Stripe currencies

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
currency_id string
country_id string

Responses

200

Currency list

get/service/restv1/account/stripe/currency

https://www.thrinacia.com/service/restv1/account/stripe/currency

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"currency_id": "string",

"country_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "stripe_country_currency_id": 1,\ \ "amex_supported": "string"\ \ }\ \ ]

tag/payments/paths/1service1restv11account1stripe~1linked/get Check Stripe link status

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id string

Responses

200

Link status

get/service/restv1/account/stripe/linked

https://www.thrinacia.com/service/restv1/account/stripe/linked

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"entry_linked": "string",

"entry_setting": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1charge-amount/get Calculate charge amount

query Parameters
amount number
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileStripeChargeAmountRetrieveRequest)

Responses

200

Charge amount result

get/service/restv1/account/stripe/charge-amount

https://www.thrinacia.com/service/restv1/account/stripe/charge-amount

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_country_currency_id": 1,

"stripe_country_id": 1,

"minimum_charge_amount": 10,

"amex_supported": "string",

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true,

"currency_id": 1,

"name": "string",

"code_iso4217_alpha": "string",

"code_iso4217_num": "string",

"native_name": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1payment-intent-direct/post Create direct payment intent

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
payment_method_id
required
string
amount
required
string
currency
required
string
description string

Responses

200

Payment intent created

post/service/restv1/account/stripe/payment-intent-direct

https://www.thrinacia.com/service/restv1/account/stripe/payment-intent-direct

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"payment_method_id": "string",

"amount": "string",

"currency": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"currency_id": 1

}`

tag/payments/paths/1service1restv11account1stripe1payment-intent-direct1confirm/post Confirm direct payment intent

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
payment_intent_id
required
string
stripe_transaction_id string
entry_id string
tip_transaction string

Responses

200

Payment intent confirmed

post/service/restv1/account/stripe/payment-intent-direct/confirm

https://www.thrinacia.com/service/restv1/account/stripe/payment-intent-direct/confirm

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"payment_intent_id": "string",

"stripe_transaction_id": "string",

"entry_id": "string",

"tip_transaction": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"result": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1express-create/post Create Stripe Express account

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (StripeExpressCreateRequest)

Unvalidated parameters passed through to Stripe express account creation.

Responses

200

Express account created

post/service/restv1/account/stripe/express-create

https://www.thrinacia.com/service/restv1/account/stripe/express-create

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"id": "acct_link_123",

"object": "account_link",

"url": "https://example.com/onboarding",

"created": 1700000000,

"expires_at": 1700003600

}`

tag/payments/paths/1service1restv11account1stripe~1express-onboard-link/post Create Stripe Express onboarding link

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
account_id
required
string

Responses

200

Onboarding link created

post/service/restv1/account/stripe/express-onboard-link

https://www.thrinacia.com/service/restv1/account/stripe/express-onboard-link

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "acct_link_123",

"object": "account_link",

"url": "https://example.com/onboarding",

"created": 1700000000,

"expires_at": 1700003600

}`

tag/payments/paths/1service1restv11account1stripe~1verify/get Verify connected Stripe account

Responses

200

Verification result

get/service/restv1/account/stripe/verify

https://www.thrinacia.com/service/restv1/account/stripe/verify

Response samples

  • 200

Content type

application/json

Copy

`{"secret_key": "string"

}`

tag/payments/paths/1service1restv11account1paypal~1application/get Get PayPal application

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfilePaypalApplicationRetrieveRequest)

Responses

200

PayPal application data

get/service/restv1/account/paypal/application

https://www.thrinacia.com/service/restv1/account/paypal/application

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"paypal_account_id": 1,

"paypal_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/payments/paths/1service1restv11account1paypal~1application/post Create PayPal application

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

PayPal application created

post/service/restv1/account/paypal/application

https://www.thrinacia.com/service/restv1/account/paypal/application

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": "string",

"secret_key": "string",

"publishable_key": "string",

"country_id": "string",

"client_id": "string",

"skip_user_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"paypal_account_id": 1,

"paypal_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/payments/paths/1service1restv11account1paypal~1country/get List PayPal countries

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfilePaypalCountryRetrieveRequest)

Responses

200

Country list

get/service/restv1/account/paypal/country

https://www.thrinacia.com/service/restv1/account/paypal/country

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "paypal_country_id": 1\ \ }\ \ ]

tag/payments/paths/1service1restv11account1paypal~1currency/get List PayPal currencies

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
currency_id string
country_id string

Responses

200

Currency list

get/service/restv1/account/paypal/currency

https://www.thrinacia.com/service/restv1/account/paypal/currency

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"currency_id": "string",

"country_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "paypal_country_currency_id": 1,\ \ "amex_supported": "string",\ \ "decimals_allowed": "string"\ \ }\ \ ]

tag/payments/paths/1service1restv11account1widgetmakr~1guest/post Create guest WidgetMakr account

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
string
email
required
string
number
required
string
exp_month
required
string
exp_year
required
string
cvc
required
string
first_name string
last_name string
personal_address_line1 string
personal_address_line2 string
personal_address_zip string
personal_city_id string
personal_phone_number string
occupation string
employer string
employer_address_line1 string
employer_address_line2 string
employer_address_zip string
employer_city_id string
pledge_level_id integer
amount number

Responses

200

Guest WidgetMakr account created

post/service/restv1/account/widgetmakr/guest

https://www.thrinacia.com/service/restv1/account/widgetmakr/guest

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": "string",

"email": "user@example.com",

"number": "string",

"exp_month": "string",

"exp_year": "string",

"cvc": "string",

"first_name": "string",

"last_name": "string",

"personal_address_line1": "string",

"personal_address_line2": "string",

"personal_address_zip": "string",

"personal_city_id": "string",

"personal_phone_number": "string",

"occupation": "string",

"employer": "string",

"employer_address_line1": "string",

"employer_address_line2": "string",

"employer_address_zip": "string",

"employer_city_id": "string",

"pledge_level_id": 0,

"amount": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"widgetmakr_cmdi_person_id": 1,

"person_id": 1,

"pid": "string",

"tracking_number": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11account1widgetmakr/post Create WidgetMakr account

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
string
number
required
string
exp_month
required
string
exp_year
required
string
cvc
required
string
first_name string
last_name string
personal_address_line1 string
personal_address_line2 string
personal_address_zip string
personal_city_id string
personal_phone_number string
occupation string
employer string
employer_address_line1 string
employer_address_line2 string
employer_address_zip string
employer_city_id string
inline_token string
pledge_level_id integer
amount number
email string

Responses

200

WidgetMakr account created

post/service/restv1/account/widgetmakr

https://www.thrinacia.com/service/restv1/account/widgetmakr

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": "string",

"number": "string",

"exp_month": "string",

"exp_year": "string",

"cvc": "string",

"first_name": "string",

"last_name": "string",

"personal_address_line1": "string",

"personal_address_line2": "string",

"personal_address_zip": "string",

"personal_city_id": "string",

"personal_phone_number": "string",

"occupation": "string",

"employer": "string",

"employer_address_line1": "string",

"employer_address_line2": "string",

"employer_address_zip": "string",

"employer_city_id": "string",

"inline_token": "string",

"pledge_level_id": 0,

"amount": 0,

"email": "user@example.com"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"widgetmakr_cmdi_person_id": 1,

"person_id": 1,

"pid": "string",

"tracking_number": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11account1widgetmakr~1widget/get Get WidgetMakr widgets

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
widgetmakr_account_id string

Responses

200

Widget list

get/service/restv1/account/widgetmakr/widget

https://www.thrinacia.com/service/restv1/account/widgetmakr/widget

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"widgetmakr_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/payments/paths/1service1restv11account1widgetmakr~1widget/post Create WidgetMakr widget

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
name
required
string
api_key
required
string
widget_instance_id
required
string

Responses

200

Widget created

post/service/restv1/account/widgetmakr/widget

https://www.thrinacia.com/service/restv1/account/widgetmakr/widget

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"api_key": "string",

"widget_instance_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11campaign1{entry_id}~1stripe-account/get Get campaign Stripe account

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id integer

Responses

200

Stripe account data

get/service/restv1/campaign/{entry_id}/stripe-account

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/stripe-account

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11campaign1{entry_id}~1pledge-transaction/get Get pledge transactions

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_transaction_entry_backer_id integer

Responses

200

Pledge transaction list

get/service/restv1/campaign/{entry_id}/pledge-transaction

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-transaction

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_transaction_entry_backer_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/payments/paths/1service1restv11campaign1account-card/put Update campaign account card

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_card_id
required
integer

Responses

200

Account card updated

put/service/restv1/campaign/account-card

https://www.thrinacia.com/service/restv1/campaign/account-card

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_card_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"entry_backer_id": 1

}`

tag/payments/paths/1service1restv11account1stripe1{stripe_account_id}1card~1{stripe_account_card_id}/get Get Stripe account card by ID

path Parameters
stripe_account_id
required
string
stripe_account_card_id
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id
required
string
stripe_account_card_id string
inline_token string

Responses

200

Card

get/service/restv1/account/stripe/{stripe_account_id}/card/{stripe_account_card_id}

https://www.thrinacia.com/service/restv1/account/stripe/{stripe\_account\_id}/card/{stripe\_account\_card\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string",

"stripe_account_card_id": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "stripe_account_card_id": 1,\ \ "stripe_account_card_type_id": 1,\ \ "stripe_account_id": 1,\ \ "card_id": 1,\ \ "fingerprint": "string",\ \ "last4": "string",\ \ "exp_month": "string",\ \ "exp_year": "string",\ \ "default_card": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z"\ \ }\ \ ]

tag/payments/paths/1service1restv11account1stripe1{stripe_account_id}1card~1{stripe_account_card_id}/put Update Stripe account card

path Parameters
stripe_account_id
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id
required
string
stripe_account_card_id
required
string
exp_month string
exp_year string
cvc string
name string
address_line1 string
address_line2 string
address_zip string
address_state string
address_country string
inline_token string
default_card string
hidden string

Responses

200

Card updated

put/service/restv1/account/stripe/{stripe_account_id}/card/{stripe_account_card_id}

https://www.thrinacia.com/service/restv1/account/stripe/{stripe\_account\_id}/card/{stripe\_account\_card\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string",

"stripe_account_card_id": "string",

"exp_month": "string",

"exp_year": "string",

"cvc": "string",

"name": "string",

"address_line1": "string",

"address_line2": "string",

"address_zip": "string",

"address_state": "string",

"address_country": "string",

"inline_token": "string",

"default_card": "string",

"hidden": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_account_card_id": 1,

"stripe_account_card_type_id": 1,

"stripe_account_id": 1,

"card_id": 1,

"fingerprint": "string",

"last4": "string",

"exp_month": "string",

"exp_year": "string",

"default_card": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"stripe_account_card_type": "string"

}`

tag/payments/paths/1service1restv11account1stripe1{stripe_account_id}1card~1{stripe_account_card_id}/delete Delete Stripe account card

path Parameters
stripe_account_id
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id
required
string
stripe_account_card_id
required
string
inline_token string

Responses

200

Card deleted

delete/service/restv1/account/stripe/{stripe_account_id}/card/{stripe_account_card_id}

https://www.thrinacia.com/service/restv1/account/stripe/{stripe\_account\_id}/card/{stripe\_account\_card\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string",

"stripe_account_card_id": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_account_card_id": 1,

"stripe_account_card_type_id": 1,

"stripe_account_id": 1,

"card_id": 1,

"fingerprint": "string",

"last4": "string",

"exp_month": "string",

"exp_year": "string",

"default_card": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"stripe_account_card_type": "string"

}`

tag/payments/paths/1service1restv11account1widgetmakr1widget1{widgetmakr_account_id}/get Get WidgetMakr widget by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
widgetmakr_account_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
widgetmakr_account_id string

Responses

200

Widget

get/service/restv1/account/widgetmakr/widget/{widgetmakr_account_id}

https://www.thrinacia.com/service/restv1/account/widgetmakr/widget/{widgetmakr\_account\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"widgetmakr_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "widgetmakr_account_id": 1,\ \ "widgetmakr_account_type_id": 1,\ \ "person_id": 1,\ \ "country_id": 1,\ \ "currency_id": 1,\ \ "widget_instance_id": 1,\ \ "api_key": "string",\ \ "name": "string",\ \ "account_data": "string",\ \ "disabled": true,\ \ "created": "2020-01-01T00:00:00Z",\ \ "modified": "2020-01-01T00:00:00Z"\ \ }\ \ ]

tag/payments/paths/1service1restv11account1widgetmakr1widget1{widgetmakr_account_id}/put Update WidgetMakr widget by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
widgetmakr_account_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
widgetmakr_account_id
required
string
name string
api_key string
widget_instance_id string

Responses

200

Widget updated

put/service/restv1/account/widgetmakr/widget/{widgetmakr_account_id}

https://www.thrinacia.com/service/restv1/account/widgetmakr/widget/{widgetmakr\_account\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"widgetmakr_account_id": "string",

"name": "string",

"api_key": "string",

"widget_instance_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11account1widgetmakr1widget1{widgetmakr_account_id}/delete Delete WidgetMakr widget by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
widgetmakr_account_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
widgetmakr_account_id
required
string

Responses

200

Widget deleted

delete/service/restv1/account/widgetmakr/widget/{widgetmakr_account_id}

https://www.thrinacia.com/service/restv1/account/widgetmakr/widget/{widgetmakr\_account\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"widgetmakr_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11campaign1{entry_id}1pledge-transaction1{stripe_transaction_entry_backer_id}/get Get pledge transaction by ID

path Parameters
entry_id
required
integer
stripe_transaction_entry_backer_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_transaction_entry_backer_id integer

Responses

200

Transaction

get/service/restv1/campaign/{entry_id}/pledge-transaction/{stripe_transaction_entry_backer_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-transaction/{stripe\_transaction\_entry\_backer\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_transaction_entry_backer_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/payments/paths/1service1restv11campaign1{entry_id}1pledge-transaction1{stripe_transaction_entry_backer_id}/put Update pledge transaction by ID

path Parameters
entry_id
required
integer
stripe_transaction_entry_backer_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Transaction updated

put/service/restv1/campaign/{entry_id}/pledge-transaction/{stripe_transaction_entry_backer_id}

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/pledge-transaction/{stripe\_transaction\_entry\_backer\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_transaction_entry_backer_id": 0,

"stripe_account_card_id": 0,

"stripe_account_card_id_previous": 0,

"use_sca": "string",

"sca_confirm_intent_capture": "string",

"retry_pledge_token": "string",

"amount_tip": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_transaction_entry_backer_id": 1,

"stripe_transaction_id": 1,

"stripe_account_card_id": 1,

"entry_backer_id": 1,

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/payments/paths/1service1restv11subscription1credit-card-type~1{...}/post Determine credit card type

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
number string

Responses

200

Card type info

400

Invalid request

500

Internal server error

post/service/restv1/subscription/credit-card-type/{...}

https://www.thrinacia.com/service/restv1/subscription/credit-card-type/{...}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"number": "string"

}`

Response samples

  • 200
  • 400
  • 500

Content type

application/json

Copy

`{"type": "string"

}`

tag/payments/paths/1service1restv11account1credit-card-type~1{...}/post Determine credit card type for account

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
number string

Responses

200

Card type

post/service/restv1/account/credit-card-type/{...}

https://www.thrinacia.com/service/restv1/account/credit-card-type/{...}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"number": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"type": "string"

}`

tag/payments/paths/1service1restv11account1stripe~1{stripe_account_id?}/get Get Stripe account data

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id string
inline_token string

Responses

200

Stripe account data

get/service/restv1/account/stripe/{stripe_account_id?}

https://www.thrinacia.com/service/restv1/account/stripe/{stripe\_account\_id?}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"currencies": [ ],

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1stripe~1{stripe_account_id}/put Update Stripe account

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
card_token string
stripe_account_id
required
string
number string
exp_month string
exp_year string
cvc string
inline_token string
name string
address_line1 string
address_line2 string
address_zip string
address_state string
address_country string

Responses

200

Stripe account updated

put/service/restv1/account/stripe/{stripe_account_id}

https://www.thrinacia.com/service/restv1/account/stripe/{stripe\_account\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"card_token": "string",

"stripe_account_id": "string",

"number": "string",

"exp_month": "string",

"exp_year": "string",

"cvc": "string",

"inline_token": "string",

"name": "string",

"address_line1": "string",

"address_line2": "string",

"address_zip": "string",

"address_state": "string",

"address_country": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1stripe~1{stripe_account_id}/delete Delete Stripe account

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id
required
string
inline_token string

Responses

200

Stripe account deleted

delete/service/restv1/account/stripe/{stripe_account_id}

https://www.thrinacia.com/service/restv1/account/stripe/{stripe\_account\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1stripe1application1{stripe_application_id}/put Update Stripe application

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
secret_key
required
string
publishable_key
required
string
country_id
required
string
client_id string
skip_user_id string

Responses

200

Stripe application updated

put/service/restv1/account/stripe/application/{stripe_application_id}

https://www.thrinacia.com/service/restv1/account/stripe/application/{stripe\_application\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"secret_key": "string",

"publishable_key": "string",

"country_id": "string",

"client_id": "string",

"skip_user_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_account_id": 1,

"secret_key": "string",

"publishable_key": "string",

"client_id": 1,

"user_id": 1

}`

tag/payments/paths/1service1restv11account1stripe1connect1{stripe_account_id?}/get Get Stripe connect data

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id string

Responses

200

Stripe connect data

get/service/restv1/account/stripe/connect/{stripe_account_id?}

https://www.thrinacia.com/service/restv1/account/stripe/connect/{stripe\_account\_id?}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"currencies": [ ],

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1stripe1connect1{stripe_account_id}/put Update Stripe connect

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id string
name string
description string

Responses

200

Stripe connect updated

put/service/restv1/account/stripe/connect/{stripe_account_id}

https://www.thrinacia.com/service/restv1/account/stripe/connect/{stripe\_account\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string",

"name": "string",

"description": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1stripe1connect1{stripe_account_id}/delete Delete Stripe connect

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id
required
string

Responses

200

Stripe connect deleted

delete/service/restv1/account/stripe/connect/{stripe_account_id}

https://www.thrinacia.com/service/restv1/account/stripe/connect/{stripe\_account\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1paypal1application1{account_paypal_application_id}/put Update PayPal application

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

PayPal application updated

put/service/restv1/account/paypal/application/{account_paypal_application_id}

https://www.thrinacia.com/service/restv1/account/paypal/application/{account\_paypal\_application\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"secret_key": "string",

"publishable_key": "string",

"country_id": "string",

"client_id": "string",

"skip_user_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"paypal_account_id": 1,

"secret_key": "string",

"publishable_key": "string",

"client_id": 1

}`

tag/payments/paths/1service1restv11account1widgetmakr~1{widgetmakr_account_id?}/get Get WidgetMakr account

Authorizations:

ApiTokenAuth__SessionCookie

Responses

200

WidgetMakr account data

get/service/restv1/account/widgetmakr/{widgetmakr_account_id?}

https://www.thrinacia.com/service/restv1/account/widgetmakr/{widgetmakr\_account\_id?}

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1widgetmakr~1{widgetmakr_account_id}/delete Delete WidgetMakr account

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
widgetmakr_account_id
required
string
inline_token string

Responses

200

WidgetMakr account deleted

delete/service/restv1/account/widgetmakr/{widgetmakr_account_id}

https://www.thrinacia.com/service/restv1/account/widgetmakr/{widgetmakr\_account\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"widgetmakr_account_id": "string",

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"country_name": "string",

"currency_name": "string",

"cards": [ ]

}`

tag/payments/paths/1service1restv11account1widgetmakr1widget1{widget_id}/put Update WidgetMakr widget

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
widgetmakr_account_id
required
string
name string
api_key string
widget_instance_id string

Responses

200

Widget updated

put/service/restv1/account/widgetmakr/widget/{widget_id}

https://www.thrinacia.com/service/restv1/account/widgetmakr/widget/{widget\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"widgetmakr_account_id": "string",

"name": "string",

"api_key": "string",

"widget_instance_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11account1widgetmakr1widget1{widget_id}/delete Delete WidgetMakr widget

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
widgetmakr_account_id
required
string

Responses

200

Widget deleted

delete/service/restv1/account/widgetmakr/widget/{widget_id}

https://www.thrinacia.com/service/restv1/account/widgetmakr/widget/{widget\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"widgetmakr_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"widgetmakr_account_id": 1,

"widgetmakr_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"widget_instance_id": 1,

"api_key": "string",

"name": "string",

"account_data": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/payments/paths/1service1restv11campaign1{campaign_id}1pledge-transaction1{pledge_transaction_id}/put Update pledge transaction

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Transaction updated

put/service/restv1/campaign/{campaign_id}/pledge-transaction/{pledge_transaction_id}

https://www.thrinacia.com/service/restv1/campaign/{campaign\_id}/pledge-transaction/{pledge\_transaction\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_transaction_entry_backer_id": 0,

"stripe_account_card_id": 0,

"stripe_account_card_id_previous": 0,

"use_sca": "string",

"sca_confirm_intent_capture": "string",

"retry_pledge_token": "string",

"amount_tip": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_transaction_entry_backer_id": 1,

"stripe_transaction_id": 1,

"stripe_account_card_id": 1,

"entry_backer_id": 1,

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"id": "string"

}`

tag/webhooks webhooks

tag/webhooks/paths/1service1restv11portal1webhook-fingerprint/get Get portal webhook fingerprint

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
fingerprint
required
string

Responses

200

Fingerprint

get/service/restv1/portal/webhook-fingerprint

https://www.thrinacia.com/service/restv1/portal/webhook-fingerprint

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"fingerprint": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"webhook_id": 1,

"webhook_endpoint_id": 1,

"webhook_action_id": 1,

"fingerprint": "string",

"content": "string",

"used": "string",

"expires": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/webhooks/paths/1service1restv11portal1webhook-fingerprint/put Update portal webhook fingerprint

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
fingerprint
required
string
used
required
string

Responses

200

Fingerprint updated

put/service/restv1/portal/webhook-fingerprint

https://www.thrinacia.com/service/restv1/portal/webhook-fingerprint

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"fingerprint": "string",

"used": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"webhook_id": 1,

"webhook_endpoint_id": 1,

"webhook_action_id": 1,

"fingerprint": "string",

"content": "string",

"used": "string",

"expires": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/admin admin

tag/admin/paths/1service1restv11account1person-inline-disable/put Disable inline person

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id
required
integer
inline_token
required
string

Responses

200

Result

put/service/restv1/account/person-inline-disable

https://www.thrinacia.com/service/restv1/account/person-inline-disable

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0,

"inline_token": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"token_id": 1,

"token_type_id": 1,

"person_id": 1,

"value": "string",

"used": "string",

"expires": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/admin/paths/1service1restv11account1stripe~1admin-connected/get Check if admin is connected to Stripe

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

object (ProfileStripeAdminConnectedRequest)

Responses

200

Admin connected status

get/service/restv1/account/stripe/admin-connected

https://www.thrinacia.com/service/restv1/account/stripe/admin-connected

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

{ }

Response samples

  • 200

Content type

application/json

Copy

`{"stripe_account_id": 1,

"person_id": 1,

"name": "string",

"description": "string"

}`

tag/admin/paths/1service1restv11portal1resource/get Get portal resources

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource list

get/service/restv1/portal/resource

https://www.thrinacia.com/service/restv1/portal/resource

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/admin/paths/1service1restv11portal1setting/get Get portal settings

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
setting string

Responses

200

Settings list

get/service/restv1/portal/setting

https://www.thrinacia.com/service/restv1/portal/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"setting": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string"\ \ }\ \ ]

tag/admin/paths/1service1restv11portal1setting/put Update portal settings

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
public string

Responses

200

Settings updated

put/service/restv1/portal/setting

https://www.thrinacia.com/service/restv1/portal/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"public": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"setting_id": 1

}`

tag/admin/paths/1service1restv11portal1setting/delete Delete portal settings

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
public string

Responses

200

Settings deleted

delete/service/restv1/portal/setting

https://www.thrinacia.com/service/restv1/portal/setting

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"public": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"setting_id": 1

}`

tag/admin/paths/1service1restv11portal1category/get Get portal category by ID

path Parameters
category_id
required
integer

Responses

200

Category

get/service/restv1/portal/category

https://www.thrinacia.com/service/restv1/portal/category

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"category_id": 1,

"parent_category_id": 1,

"name": "string",

"description": "string",

"icon": "string",

"display_priority": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"subcategories": [ ],

"uri_paths": [ ]

}`

tag/admin/paths/1service1restv11portal1category/post Create portal category

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Category created

post/service/restv1/portal/category

https://www.thrinacia.com/service/restv1/portal/category

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"description": "string",

"parent_category_id": 0,

"display_priority": "string",

"attributes": "string",

"uri_path": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"category_id": 1,

"parent_category_id": 1,

"name": "string",

"description": "string",

"icon": "string",

"display_priority": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"subcategories": [ ],

"uri_paths": [ ]

}`

tag/admin/paths/1service1restv11portal1page/get Get portal pages

query Parameters
page_id integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
page_id integer

Responses

200

Page list or single page

get/service/restv1/portal/page

https://www.thrinacia.com/service/restv1/portal/page

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"page_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/admin/paths/1service1restv11portal1page/post Create portal page

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Page created

post/service/restv1/portal/page

https://www.thrinacia.com/service/restv1/portal/page

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"name": "string",

"title": "string",

"content": "string",

"path": "string",

"path_text": "string",

"meta": "string",

"display_priority": "string",

"published": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"page_id": 1,

"uri_path_id": 1,

"name": "string",

"title": "string",

"content": "string",

"meta": "string",

"display_priority": "string",

"published": "string",

"reserved": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"path": "string",

"path_text": "string"

}`

tag/admin/paths/1service1restv11portal1coupon/get Get portal coupons

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
coupon_id integer

Responses

200

Coupon list

get/service/restv1/portal/coupon

https://www.thrinacia.com/service/restv1/portal/coupon

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/admin/paths/1service1restv11portal1coupon/post Create portal coupon

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Coupon created

post/service/restv1/portal/coupon

https://www.thrinacia.com/service/restv1/portal/coupon

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"code": "string",

"name": "string",

"description": "string",

"discount_amount": 0,

"discount_percentage": 0,

"expires_date_time": "2019-08-24T14:15:22Z",

"expires_quantity": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"coupon_id": 1,

"code": "string",

"name": "string",

"description": "string",

"discount_amount": 10,

"discount_percentage": "string",

"expires_date_time": "string",

"expires_quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/admin/paths/1service1restv11portal1person/get Get portal people

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
filters string

Responses

200

People list

get/service/restv1/portal/person

https://www.thrinacia.com/service/restv1/portal/person

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/admin/paths/1service1restv11portal1person/post Create portal person

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Person created

post/service/restv1/portal/person

https://www.thrinacia.com/service/restv1/portal/person

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"first_name": "string",

"last_name": "string",

"bio": "string",

"person_status_id": "string",

"person_type_id": "string",

"email": "user@example.com",

"password": "string",

"password_confirm": "string",

"password_scheme": "string",

"password_scheme_options": "string",

"password_passthrough": "string",

"use_widgetmakr": "string",

"pid": "string",

"tracking_number": "string",

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"inline_token": "string",

"person_id": 1,

"token": "token_example"

}`

tag/admin/paths/1service1restv11portal1person~1attribute/get Get portal person attributes

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
filters string

Responses

200

Person attributes list

get/service/restv1/portal/person/attribute

https://www.thrinacia.com/service/restv1/portal/person/attribute

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"filters": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"person_id": 1,\ \ "attributes": "string"\ \ }\ \ ]

tag/admin/paths/1service1restv11portal1stats/get Get portal stats

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_id
required
integer
summary integer
use_widgetmakr integer

Responses

200

Stats

get/service/restv1/portal/stats

https://www.thrinacia.com/service/restv1/portal/stats

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"summary": 0,

"use_widgetmakr": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"refreshed": "string",

"total_campaigns": "string",

"total_campaigns_being_edited": "string",

"total_campaigns_running": "string",

"total_campaigns_not_approved": "string",

"total_campaigns_paused": "string",

"total_campaigns_processing_pre_auth": "string",

"total_campaigns_processing_accepted_capture": "string",

"total_campaigns_processing_declined_capture": "string",

"total_campaigns_processing_processing_capture": "string",

"total_campaigns_processing_capture_complete": "string",

"total_campaigns_sent_for_review": "string",

"total_campaigns_cancelled": "string",

"total_campaigns_being_reviewed": "string",

"total_campaigns_not_funded": "string",

"total_campaigns_processing": "string",

"total_campaign_funding_sought": "string",

"total_campaign_funding_sought_running": "string",

"total_campaign_funding_sought_capture_complete": "string",

"total_campaign_funding_raised_running": "string",

"total_campaign_funding_raised_capture_complete": "string"

}`

tag/admin/paths/1service1restv11portal1uri-path/get Get portal URI path

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
uri_path string

Responses

200

URI path

get/service/restv1/portal/uri-path

https://www.thrinacia.com/service/restv1/portal/uri-path

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"uri_path": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"result": "string"

}`

tag/admin/paths/1service1restv11portal1campaign-revision/get Get portal campaign revisions

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
entry_revision_id integer

Responses

200

Campaign revisions

get/service/restv1/portal/campaign-revision

https://www.thrinacia.com/service/restv1/portal/campaign-revision

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_revision_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

[{"id": "string",\ \ "manager_first_name": "string",\ \ "manager_last_name": "string"\ \ }\ \ ]

tag/admin/paths/1service1restv11portal1account-login-link/get Generate account login link

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
stripe_account_id string

Responses

200

Login link

get/service/restv1/portal/account-login-link

https://www.thrinacia.com/service/restv1/portal/account-login-link

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"stripe_account_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"stripe_account_id": 1,

"stripe_account_type_id": 1,

"person_id": 1,

"country_id": 1,

"currency_id": 1,

"user_id": 1,

"client_id": 1,

"connect_code": "string",

"secret_key": "string",

"publishable_key": "string",

"refresh_token": "string",

"access_token": "string",

"email": "user@example.com",

"name": "string",

"description": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/admin/paths/1service1restv11portal1people/get Get portal people addresses

Authorizations:

ApiTokenAuth__SessionCookie

Responses

200

People address list

get/service/restv1/portal/people

https://www.thrinacia.com/service/restv1/portal/people

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/admin/paths/1service1restv11campaign1{entry_id}~1replicate/post Replicate campaign

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
entry_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Replication result

post/service/restv1/campaign/{entry_id}/replicate

https://www.thrinacia.com/service/restv1/campaign/{entry\_id}/replicate

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"entry_id": 0,

"name": "string",

"description": "string",

"blurb": "string",

"funding_goal": 0,

"starts": "2019-08-24T14:15:22Z",

"ends": "2019-08-24T14:15:22Z",

"runtime_days": 0,

"city_id": "string",

"category_id": "string",

"currency_id": "string",

"stripe_account_id": "string",

"raise_mode_id": "string",

"profile_type_id": "string",

"business_organization_id": "string",

"featured": "string",

"display_priority": "string",

"hidden": "string",

"private": "string",

"force_direct_transaction": "string",

"maximum_allowed_funds_raised": 0,

"duration_type_id": "string",

"uri_path": "string",

"skip_path_update": "string",

"backer_offset": "string",

"created": "string",

"modified": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"entry_manager_id": 1,

"person_id": 1,

"entry_id": 1,

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/admin/paths/1service1restv11portal1resource~1{resource_type}/get Get portal resources by type

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
resource_type
required
string
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource list

get/service/restv1/portal/resource/{resource_type}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/admin/paths/1service1restv11portal1resource~1{resource_type}/post Create portal resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required

Responses

200

Resource created

post/service/restv1/portal/resource/{resource_type}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"region_resource_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"category_id": 1,

"category_name": "string",

"region_id": 1

}`

tag/admin/paths/1service1restv11portal1resource1{resource_type}1{resource_id}/put Update portal resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json required

Responses

200

Resource updated

put/service/restv1/portal/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"resource_content_type": "string",

"resource": "string",

"business_organization_id": 0,

"person_id": 0,

"region_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"region_resource_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"category_id": 1,

"category_name": "string",

"region_id": 1

}`

tag/admin/paths/1service1restv11portal1resource1{resource_type}1{resource_id}/delete Delete portal resource

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Resource deleted

delete/service/restv1/portal/resource/{resource_type}/{resource_id}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type}/{resource\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"region_resource_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"category_id": 1,

"category_name": "string",

"region_id": 1

}`

tag/admin/paths/1service1restv11portal1category~1{category_id}/put Update portal category

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Category updated

put/service/restv1/portal/category/{category_id}

https://www.thrinacia.com/service/restv1/portal/category/{category\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"category_id": 0,

"name": "string",

"description": "string",

"parent_category_id": 0,

"display_priority": "string",

"attributes": "string",

"uri_path": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"category_id": 1,

"parent_category_id": 1,

"name": "string",

"description": "string",

"icon": "string",

"display_priority": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"uri_path_id": 1,

"path": "string",

"path_text": "string"

}`

tag/admin/paths/1service1restv11portal1category~1{category_id}/delete Delete portal category

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
category_id
required
integer

Responses

200

Category deleted

delete/service/restv1/portal/category/{category_id}

https://www.thrinacia.com/service/restv1/portal/category/{category\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"category_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

`{"id": "string",

"category_id": 1,

"parent_category_id": 1,

"name": "string",

"description": "string",

"icon": "string",

"display_priority": "string",

"attributes": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"subcategories": [ ],

"uri_paths": [ ]

}`

tag/admin/paths/1service1restv11portal1page~1{page_id}/get Get portal page by ID

path Parameters
page_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
page_id integer

Responses

200

Page

get/service/restv1/portal/page/{page_id}

https://www.thrinacia.com/service/restv1/portal/page/{page\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"page_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/admin/paths/1service1restv11portal1page~1{page_id}/put Update portal page

Authorizations:

ApiTokenAuth__SessionCookie

query Parameters
page_id integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Page updated

put/service/restv1/portal/page/{page_id}

https://www.thrinacia.com/service/restv1/portal/page/{page\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"page_id": 0,

"title": "string",

"name": "string",

"content": "string",

"path": "string",

"path_text": "string",

"meta": "string",

"display_priority": "string",

"published": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"uri_path_id": 1

}`

tag/admin/paths/1service1restv11portal1page~1{page_id}/delete Delete portal page

Authorizations:

ApiTokenAuth__SessionCookie

query Parameters
page_id integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
page_id
required
integer

Responses

200

Page deleted

delete/service/restv1/portal/page/{page_id}

https://www.thrinacia.com/service/restv1/portal/page/{page\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"page_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"page_id": 1,

"uri_path_id": 1,

"name": "string",

"title": "string",

"content": "string",

"meta": "string",

"display_priority": "string",

"published": "string",

"reserved": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"path": "string",

"path_text": "string"

}`

tag/admin/paths/1service1restv11portal1coupon~1{coupon_id}/get Get portal coupon by ID

path Parameters
coupon_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
coupon_id integer

Responses

200

Coupon

get/service/restv1/portal/coupon/{coupon_id}

https://www.thrinacia.com/service/restv1/portal/coupon/{coupon\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy Expand all Collapse all

tag/admin/paths/1service1restv11portal1coupon~1{coupon_id}/put Update portal coupon

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Coupon updated

put/service/restv1/portal/coupon/{coupon_id}

https://www.thrinacia.com/service/restv1/portal/coupon/{coupon\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0,

"code": "string",

"name": "string",

"description": "string",

"discount_amount": 0,

"discount_percentage": 0,

"expires_date_time": "2019-08-24T14:15:22Z",

"expires_quantity": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"coupon_id": 1,

"code": "string",

"name": "string",

"description": "string",

"discount_amount": 10,

"discount_percentage": "string",

"expires_date_time": "string",

"expires_quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/admin/paths/1service1restv11portal1coupon~1{coupon_id}/delete Delete portal coupon

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
coupon_id
required
integer

Responses

200

Coupon deleted

delete/service/restv1/portal/coupon/{coupon_id}

https://www.thrinacia.com/service/restv1/portal/coupon/{coupon\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"coupon_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"coupon_id": 1,

"code": "string",

"name": "string",

"description": "string",

"discount_amount": 10,

"discount_percentage": "string",

"expires_date_time": "string",

"expires_quantity": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z"

}`

tag/admin/paths/1service1restv11portal1person~1{person_id}/put Update portal person

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Responses

200

Person updated

put/service/restv1/portal/person/{person_id}

https://www.thrinacia.com/service/restv1/portal/person/{person\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"first_name": "string",

"last_name": "string",

"bio": "string",

"person_id": "string",

"person_status_id": "string",

"person_type_id": "string",

"email": "user@example.com",

"password": "string",

"password_confirm": "string",

"password_scheme": "string",

"password_scheme_options": "string",

"password_passthrough": "string",

"use_widgetmakr": "string",

"pid": "string",

"tracking_number": "string",

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"person_id": 1,

"person_type_id": 1,

"person_status_id": 1,

"first_name": "string",

"last_name": "string",

"email": "user@example.com",

"id": "string",

"bio": "string",

"attributes": "string",

"campaign_manager": true,

"campaign_backer": true,

"portal_admin": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/admin/paths/1service1restv11portal1person~1{person_id}/delete Delete portal person

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id integer

Responses

200

Person deleted

delete/service/restv1/portal/person/{person_id}

https://www.thrinacia.com/service/restv1/portal/person/{person\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": 0

}`

Response samples

  • 200

Content type

application/json

Copy

`{"person_id": 1,

"person_type_id": 1,

"person_status_id": 1,

"first_name": "string",

"last_name": "string",

"email": "user@example.com",

"id": "string",

"bio": "string",

"attributes": "string",

"campaign_manager": true,

"campaign_backer": true,

"portal_admin": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"disabled": true

}`

tag/admin/paths/1service1restv11portal1person1attribute1{person_id}/put Update portal person attributes

Authorizations:

ApiTokenAuth__SessionCookie

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
person_id
required
string
attributes string

Responses

200

Attributes updated

put/service/restv1/portal/person/attribute/{person_id}

https://www.thrinacia.com/service/restv1/portal/person/attribute/{person\_id}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"person_id": "string",

"attributes": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"person_id": 1,

"attributes": "string"

}`

tag/admin/paths/1service1restv11portal1resource1{resource_type?}1{resource_id?}/get Get portal resource by ID

Authorizations:

ApiTokenAuth__SessionCookie

path Parameters
resource_type
required
string
resource_id
required
integer
Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required
resource_id string
resource_type
required
string
business_organization_id integer
person_id string

Responses

200

Resource

get/service/restv1/portal/resource/{resource_type?}/{resource_id?}

https://www.thrinacia.com/service/restv1/portal/resource/{resource\_type?}/{resource\_id?}

Request samples

  • Payload

Content type

application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{"resource_id": "string",

"resource_type": "string",

"business_organization_id": 0,

"person_id": "string"

}`

Response samples

  • 200

Content type

application/json

Copy

`{"id": "string",

"file_id": 1,

"file_type_id": 1,

"name": "string",

"path_internal": "string",

"path_external": "string",

"disabled": true,

"created": "2020-01-01T00:00:00Z",

"modified": "2020-01-01T00:00:00Z",

"resource_type": "string",

"region_resource_id": 1,

"resource_content_type": "string",

"resource_content_type_id": 1,

"file_type": "string",

"description": "string",

"mime_type": "string",

"extension": "string",

"category_id": 1,

"category_name": "string",

"region_id": 1

}`