Loading API Documentation...
API docs by Redocly

Thrinacia REST API (1.0)

Download OpenAPI specification:

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.

auth

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:
required
email
required
string <email>
password
required
string
code
string
password_scheme
string
password_scheme_options
string
turnstile_token
string

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "password": "secret",
  • "code": "123456",
  • "turnstile_token": "cf-turnstile-token"
}

Response samples

Content type
application/json
{
  • "person_id": 123,
  • "email": "user@example.com",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "auth_token": "sessionid"
}

Get current authentication info

Returns current session's authenticated person, if any.

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
object (ProfileAuthenticateRetrieveRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "person_id": 0,
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string"
}

Authenticate via Okta password flow

Request Body schema:
required
email
required
string <email>
password
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "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"
}

Authenticate via Okta social token

Request Body schema:
required
id_token
required
string

Responses

Request samples

Content type
{
  • "id_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Begin password reset

Request Body schema:
required
email
required
string <email>

Responses

Request samples

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

Response samples

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

Validate reset token

query Parameters
token
required
string
Request Body schema:
required
token
required
string

Responses

Request samples

Content type
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "validated": false
}

Confirm password reset

Request Body schema:
required
token
required
string
password
required
string
password_confirm
required
string

Responses

Request samples

Content type
{
  • "token": "string",
  • "password": "string",
  • "password_confirm": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Register a new account

Turnstile token may be required when enabled.

Request Body schema:
required
first_name
required
string
last_name
required
string
email
required
string <email>
password
required
string
password_confirm
required
string
inline_registration
string
use_widgetmakr
string
attributes
string
express_checkout
string
turnstile_token
string

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "person_id": 123,
  • "token": null
}

Confirm a registration token

Request Body schema:
required
token
required
string

Responses

Request samples

Content type
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "id": "token",
  • "activated": 1,
  • "email": "user@example.com"
}

Resend confirmation

Request Body schema:
required
email
required
string <email>

Responses

Request samples

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

Response samples

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

Destroy the active session

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
object (ProfileLogoutRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "success": false
}

Retrieve TFA configuration

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
object (ProfilePersonTfaGenerateRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "enabled": true,
  • "qr_code_url": "string",
  • "recovery_codes": "string",
  • "secret": "string"
}

Verify TFA code

Authorizations:
ApiTokenAuthSessionCookie
query Parameters
code
string
Request Body schema:
required
object (ProfilePersonTfaVerifyRequest)

Responses

Request samples

Content type
{ }

Response samples

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

Get email addresses

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
email
required
string <email>

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Add email address

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
object (ProfileAccountSubmitEmailRequest)

Responses

Request samples

Content type
{ }

Response samples

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

Confirm email change (GET)

Authorizations:
ApiTokenAuthSessionCookie
query Parameters
token
string
Request Body schema:
required
token
required
string

Responses

Request samples

Content type
{
  • "token": "string"
}

Response samples

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

Confirm email change (POST)

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
token
required
string
email
required
string <email>

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "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"
}

Generate account login link

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
stripe_account_id
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Generate captcha image

Responses

Response samples

Content type
image/*
string

users

Submit contact form

Request Body schema:
required
name
required
string
description
required
string
email
required
string <email>
phone
string
business_organization
string
source
string
website
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "business_organization": "string",
  • "source": "string",
  • "website": "string"
}

Response samples

Content type
application/json
{
  • "success": false
}

Update account profile

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
first_name
string
last_name
string
bio
string
password_old
string
password
string
password_confirm
string

Responses

Request samples

Content type
{
  • "first_name": "string",
  • "last_name": "string",
  • "bio": "string",
  • "password_old": "string",
  • "password": "string",
  • "password_confirm": "string"
}

Response samples

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

Get account settings

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
setting
string

Responses

Request samples

Content type
{
  • "setting": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete account setting

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
public
string

Responses

Request samples

Content type
{
  • "public": "string"
}

Response samples

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

Create guest address

Request Body schema:
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

Request samples

Content type
{
  • "business_organization_id": 0,
  • "city_id": 0,
  • "city_alt": "string",
  • "mail_code": "string",
  • "street1": "string",
  • "street2": "string",
  • "description": "string",
  • "primary_address": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get addresses

Request Body schema:
required
person_id
integer
business_organization_id
integer
address_id
integer
inline_token
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "business_organization_id": 0,
  • "address_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create address

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get phone numbers

Request Body schema:
required
person_id
integer
business_organization_id
integer
phone_number_id
integer
inline_token
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "business_organization_id": 0,
  • "phone_number_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create phone number

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get websites

Request Body schema:
required
uri_id
integer
business_organization_id
integer
person_id
integer

Responses

Request samples

Content type
{
  • "uri_id": 0,
  • "business_organization_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create website

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
business_organization_id
integer
uri
string
uri_text
string
person_id
integer

Responses

Request samples

Content type
{
  • "business_organization_id": 0,
  • "uri": "string",
  • "uri_text": "string",
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get account resources

Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
{
  • "personal": [
    ],
  • "business": [
    ]
}

Get account messages

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
message_id
string
filters
string

Responses

Request samples

Content type
{
  • "message_id": "string",
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create account message

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_id
required
string
subject
required
string
body
required
string
first_name
string
last_name
string
email
string

Responses

Request samples

Content type
{
  • "person_id": "string",
  • "subject": "string",
  • "body": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get account person details

Request Body schema:
required
person_id
required
integer

Responses

Request samples

Content type
{
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "person_id": 0,
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string"
}

Get account actions

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_action_id
integer
filters
string

Responses

Request samples

Content type
{
  • "person_action_id": 0,
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create account action

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_action_type_id
required
integer
person_id_source
integer
person_id_target
required
integer
anonymous
string

Responses

Request samples

Content type
{
  • "person_action_type_id": 0,
  • "person_id_source": 0,
  • "person_id_target": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Dashboard thumbnail image

Responses

Response samples

Content type
image/*
string

Get a specific address

path Parameters
address_id
required
integer
Request Body schema:
required
person_id
integer
business_organization_id
integer
address_id
integer
inline_token
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "business_organization_id": 0,
  • "address_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update address

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete address

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
business_organization_id
integer
person_id
integer
address_id
required
integer
inline_token
string

Responses

Request samples

Content type
{
  • "business_organization_id": 0,
  • "person_id": 0,
  • "address_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get a specific phone number

path Parameters
phone_number_id
required
integer
Request Body schema:
required
person_id
integer
business_organization_id
integer
phone_number_id
integer
inline_token
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "business_organization_id": 0,
  • "phone_number_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update phone number

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete phone number

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
business_organization_id
integer
person_id
integer
phone_number_id
required
integer
inline_token
string

Responses

Request samples

Content type
{
  • "business_organization_id": 0,
  • "person_id": 0,
  • "phone_number_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get a specific website entry

path Parameters
uri_id
required
integer
Request Body schema:
required
uri_id
integer
business_organization_id
integer
person_id
integer

Responses

Request samples

Content type
{
  • "uri_id": 0,
  • "business_organization_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update website entry by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
uri_id
required
integer
Request Body schema:
required
business_organization_id
integer
person_id
integer
uri_id
required
integer
uri
string
uri_text
string

Responses

Request samples

Content type
{
  • "business_organization_id": 0,
  • "person_id": 0,
  • "uri_id": 0,
  • "uri": "string",
  • "uri_text": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete website entry by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
uri_id
required
integer
Request Body schema:
required
business_organization_id
integer
person_id
integer
uri_id
required
integer

Responses

Request samples

Content type
{
  • "business_organization_id": 0,
  • "person_id": 0,
  • "uri_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get account resources by type

path Parameters
resource_type
required
string
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
{
  • "personal": [
    ],
  • "business": [
    ]
}

Create account resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
resource_type
required
string
resource_content_type
required
string
resource
required
string
business_organization_id
integer
person_id
integer
region_id
integer

Responses

Request samples

Content type
{
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get account resource by ID

path Parameters
resource_type
required
string
resource_id
required
integer
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Update account resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Delete account resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
resource_id
required
string
resource_type
required
string
business_organization_id
integer
person_id
integer

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get message by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
message_id
required
integer
Request Body schema:
required
message_id
string
filters
string

Responses

Request samples

Content type
{
  • "message_id": "string",
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete account message

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
message_id
required
string

Responses

Request samples

Content type
{
  • "message_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get account action by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
person_action_id
required
integer
Request Body schema:
required
person_action_id
integer
filters
string

Responses

Request samples

Content type
{
  • "person_action_id": 0,
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update account action by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
person_action_id
required
integer
Request Body schema:
required
person_action_id
required
integer
person_action_type_id
integer
person_id_source
integer
person_id_target
integer
anonymous
string

Responses

Request samples

Content type
{
  • "person_action_id": 0,
  • "person_action_type_id": 0,
  • "person_id_source": 0,
  • "person_id_target": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete account action by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
person_action_id
required
integer
Request Body schema:
required
person_action_id
required
integer
person_id_source
integer

Responses

Request samples

Content type
{
  • "person_action_id": 0,
  • "person_id_source": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update account settings

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
public
string

Responses

Request samples

Content type
{
  • "public": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Update website

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
business_organization_id
integer
person_id
integer
uri_id
required
integer
uri
string
uri_text
string

Responses

Request samples

Content type
{
  • "business_organization_id": 0,
  • "person_id": 0,
  • "uri_id": 0,
  • "uri": "string",
  • "uri_text": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete website

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
business_organization_id
integer
person_id
integer
uri_id
required
integer

Responses

Request samples

Content type
{
  • "business_organization_id": 0,
  • "person_id": 0,
  • "uri_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update account action

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_action_id
required
integer
person_action_type_id
integer
person_id_source
integer
person_id_target
integer
anonymous
string

Responses

Request samples

Content type
{
  • "person_action_id": 0,
  • "person_action_type_id": 0,
  • "person_id_source": 0,
  • "person_id_target": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete account action

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_action_id
required
integer
person_id_source
integer

Responses

Request samples

Content type
{
  • "person_action_id": 0,
  • "person_id_source": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

orgs

List or search cities

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

query Parameters
native_lookup
boolean
subcountry_id
integer
Request Body schema:
required
city_prefix
string
native_lookup
string
subcountry_id
string

Responses

Request samples

Content type
{
  • "city_prefix": "string",
  • "native_lookup": "string",
  • "subcountry_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

List countries

Request Body schema:
required
object (ProfileLocaleCountryRetrieveRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
[
  • {
    }
]

List subcountry prefixes

Request Body schema:
required
subcountry_prefix
required
string
native_lookup
string

Responses

Request samples

Content type
{
  • "subcountry_prefix": "string",
  • "native_lookup": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

List subcountries

Request Body schema:
required
country_id
required
string

Responses

Request samples

Content type
{
  • "country_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

List currencies

Request Body schema:
required
object (ProfileLocaleCurrencyRetrieveRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Create guest business organization

Request Body schema:
required
name
required
string
description
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get business organizations

Request Body schema:
required
person_id
integer
business_organization_id
integer
inline_token
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "business_organization_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create business organization

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_id
integer
name
required
string
email
string
description
string
inline_token
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "name": "string",
  • "email": "string",
  • "description": "string",
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal resources

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get portal settings

Request Body schema:
required
setting
string

Responses

Request samples

Content type
{
  • "setting": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update portal settings

Request Body schema:
required
public
string

Responses

Request samples

Content type
{
  • "public": "string"
}

Response samples

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

Delete portal settings

Request Body schema:
required
public
string

Responses

Request samples

Content type
{
  • "public": "string"
}

Response samples

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

Get portal category by ID

path Parameters
category_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "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": [ ]
}

Create portal category

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
name
required
string
description
string
parent_category_id
integer
display_priority
string
attributes
string
uri_path
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "parent_category_id": 0,
  • "display_priority": "string",
  • "attributes": "string",
  • "uri_path": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get portal pages

query Parameters
page_id
integer
Request Body schema:
required
page_id
integer

Responses

Request samples

Content type
{
  • "page_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create portal page

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
name
required
string
title
string
content
string
path
string
path_text
string
meta
string
display_priority
string
published
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "title": "string",
  • "content": "string",
  • "path": "string",
  • "path_text": "string",
  • "meta": "string",
  • "display_priority": "string",
  • "published": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal coupons

Request Body schema:
required
coupon_id
integer

Responses

Request samples

Content type
{
  • "coupon_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create portal coupon

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
code
required
string
name
required
string
description
string
discount_amount
number
discount_percentage
number
expires_date_time
string <date-time>
expires_quantity
integer

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get portal people

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
filters
string

Responses

Request samples

Content type
{
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create portal person

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
first_name
required
string
last_name
required
string
bio
string
person_status_id
string
person_type_id
string
email
required
string <email>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "id": "string",
  • "inline_token": "string",
  • "person_id": 1,
  • "token": "token_example"
}

Get portal person attributes

Request Body schema:
required
filters
string

Responses

Request samples

Content type
{
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Submit portal contact form

Request Body schema:
required
name
required
string
description
required
string
email
required
string <email>
phone
string
business_organization
string
source
string
website
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "business_organization": "string",
  • "source": "string",
  • "website": "string"
}

Response samples

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

Get portal stats

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
entry_id
required
integer
summary
integer
use_widgetmakr
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "summary": 0,
  • "use_widgetmakr": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal URI path

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
uri_path
string

Responses

Request samples

Content type
{
  • "uri_path": "string"
}

Response samples

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

Public portal person lookup

Request Body schema:
required
filters
string

Responses

Request samples

Content type
{
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get portal token

Request Body schema:
required
type
string

Responses

Request samples

Content type
{
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "token": "token_example",
  • "type": "string"
}

Get ReferralCandy integration status

Request Body schema:
required
email
required
string
first_name
required
string
invoice_amount
required
string
timestamp
required
string

Responses

Request samples

Content type
{
  • "email": "string",
  • "first_name": "string",
  • "invoice_amount": "string",
  • "timestamp": "string"
}

Response samples

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

Get portal people addresses

Authorizations:
ApiTokenAuthSessionCookie

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Site logo image

Responses

Response samples

Content type
image/*
string

Site logo fit image

Responses

Response samples

Content type
image/*
string

Site logo fill image

Responses

Response samples

Content type
image/*
string

Site logo min image

Responses

Response samples

Content type
image/*
string

Site logo max image

Responses

Response samples

Content type
image/*
string

Site logo 160x36 image

Responses

Response samples

Content type
image/*
string

Site logo 320x80 image

Responses

Response samples

Content type
image/*
string

Site favicon 16x16 image

Responses

Response samples

Content type
image/*
string

Site favicon 32x32 image

Responses

Response samples

Content type
image/*
string

Portal preview background image

Responses

Response samples

Content type
image/*
string

Get a specific business organization

path Parameters
business_organization_id
required
integer
Request Body schema:
required
person_id
integer
business_organization_id
integer
inline_token
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "business_organization_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update business organization

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_id
integer
business_organization_id
required
integer
name
string
email
string
description
string
inline_token
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "business_organization_id": 0,
  • "name": "string",
  • "email": "string",
  • "description": "string",
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete business organization

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
business_organization_id
required
integer
inline_token
string

Responses

Request samples

Content type
{
  • "business_organization_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal resources by type

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
resource_type
required
string
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create portal resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
resource_type
required
string
resource_content_type
required
string
resource
required
string
business_organization_id
integer
person_id
integer
region_id
integer

Responses

Request samples

Content type
{
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update portal resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Delete portal resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
resource_id
required
string
resource_type
required
string
business_organization_id
integer
person_id
integer

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update portal category

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
category_id
required
integer
name
required
string
description
string
parent_category_id
integer
display_priority
string
attributes
string
uri_path
string

Responses

Request samples

Content type
{
  • "category_id": 0,
  • "name": "string",
  • "description": "string",
  • "parent_category_id": 0,
  • "display_priority": "string",
  • "attributes": "string",
  • "uri_path": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete portal category

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
category_id
required
integer

Responses

Request samples

Content type
{
  • "category_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get portal page by ID

path Parameters
page_id
required
integer
Request Body schema:
required
page_id
integer

Responses

Request samples

Content type
{
  • "page_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update portal page

Authorizations:
ApiTokenAuthSessionCookie
query Parameters
page_id
integer
Request Body schema:
required
page_id
required
integer
title
string
name
string
content
string
path
string
path_text
string
meta
string
display_priority
string
published
string

Responses

Request samples

Content type
{
  • "page_id": 0,
  • "title": "string",
  • "name": "string",
  • "content": "string",
  • "path": "string",
  • "path_text": "string",
  • "meta": "string",
  • "display_priority": "string",
  • "published": "string"
}

Response samples

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

Delete portal page

Authorizations:
ApiTokenAuthSessionCookie
query Parameters
page_id
integer
Request Body schema:
required
page_id
required
integer

Responses

Request samples

Content type
{
  • "page_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal coupon by ID

path Parameters
coupon_id
required
integer
Request Body schema:
required
coupon_id
integer

Responses

Request samples

Content type
{
  • "coupon_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update portal coupon

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
coupon_id
required
integer
code
string
name
string
description
string
discount_amount
number
discount_percentage
number
expires_date_time
string <date-time>
expires_quantity
integer

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete portal coupon

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
coupon_id
required
integer

Responses

Request samples

Content type
{
  • "coupon_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update portal person

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
first_name
string
last_name
string
bio
string
person_id
required
string
person_status_id
string
person_type_id
string
email
string <email>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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
}

Delete portal person

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_id
integer

Responses

Request samples

Content type
{
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update portal person attributes

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_id
required
string
attributes
string

Responses

Request samples

Content type
{
  • "person_id": "string",
  • "attributes": "string"
}

Response samples

Content type
application/json
{
  • "person_id": 1,
  • "attributes": "string"
}

Get portal resource by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
resource_type
required
string
resource_id
required
integer
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
{
  • "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
}

campaigns

Get portal campaign revisions

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
entry_revision_id
integer

Responses

Request samples

Content type
{
  • "entry_revision_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

List campaigns

Request Body schema:
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 <date-time>
ends
string <date-time>
runtime_days
integer
filters
string
use_path_lookup
string
path_lookup_case_insensitive
string
path
string

Responses

Request samples

Content type
{
  • "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

Content type
application/json
[
  • {
    }
]

Create campaign

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
name
required
string
description
string
blurb
string
funding_goal
number
starts
string <date-time>
ends
string <date-time>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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
}

List campaign statuses

Request Body schema:
required
entry_status_id
integer

Responses

Request samples

Content type
{
  • "entry_status_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

List campaign raise modes

Request Body schema:
required
raise_mode_id
integer

Responses

Request samples

Content type
{
  • "raise_mode_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Get pledge levels

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
integer
pledge_level_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "pledge_level_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create pledge level

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
name
required
string
description
string
amount
number
estimated_delivery_time
string <date-time>
item_limit
integer
attributes
string
expires
string <date-time>
coupon_id
integer
priority
number

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get pledge level shipping options

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema:
required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "pledge_level_id": 0,
  • "shipping_option_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create pledge level shipping option

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get campaign Stripe account

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign resources

path Parameters
entry_id
required
integer
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get campaign resource revisions

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
resource_revision_id
string
resource_type
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "resource_revision_id": "string",
  • "resource_type": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get campaign FAQs

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign FAQ

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
name
required
string
description
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get campaign FAQ pairs

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "faq_pair_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Get FAQ revisions

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create FAQ revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
name
required
string
description
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get FAQ pair revisions

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "faq_pair_revision_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Validate campaign video URL

query Parameters
url
string
Request Body schema:
required
link
required
string

Responses

Request samples

Content type
{
  • "link": "string"
}

Response samples

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

Get campaign verification status

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
verify_type_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "verify_type_id": 0
}

Response samples

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

Create/update campaign verification

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
verify_type_id
required
integer
data
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "verify_type_id": 0,
  • "data": "string"
}

Response samples

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

Get campaign notes

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_note_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_note_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign note

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
value
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign stream

path Parameters
entry_id
required
integer
Request Body schema:
required
stream_id
integer
entry_id
required
integer

Responses

Request samples

Content type
{
  • "stream_id": 0,
  • "entry_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign stream entry

path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "stream_type_id": 0,
  • "entry_id": 0,
  • "person_id": "string",
  • "title": "string",
  • "message": "string",
  • "published": "string",
  • "display_priority": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Notify campaign stream subscribers

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
stream_id
integer
entry_id
required
integer

Responses

Request samples

Content type
{
  • "stream_id": 0,
  • "entry_id": 0
}

Response samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "user@example.com"
}

Get campaign settings

path Parameters
entry_id
required
integer
Request Body schema:
required
setting
string

Responses

Request samples

Content type
{
  • "setting": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete campaign settings

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
public
string

Responses

Request samples

Content type
{
  • "public": "string"
}

Response samples

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

Get campaign setting revisions

path Parameters
entry_id
required
integer
Request Body schema:
required
setting
string

Responses

Request samples

Content type
{
  • "setting": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete campaign setting revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
object (ProfileSettingRevisionDeleteRequest)

Responses

Request samples

Content type
{ }

Response samples

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

Get campaign groups

Request Body schema:
required
group_id
string

Responses

Request samples

Content type
{
  • "group_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign group

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
name
required
string
description
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

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

Get campaign comments

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign comment

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
person_id
integer
title
string
anonymous
string
message
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "person_id": 0,
  • "title": "string",
  • "anonymous": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get comment actions

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
required
integer
comment_action_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0,
  • "comment_action_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create comment action

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
required
integer
comment_action_type_id
required
integer
person_id
integer
anonymous
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0,
  • "comment_action_type_id": 0,
  • "person_id": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get campaign actions

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_action_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_action_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign action

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_action_type_id
required
integer
person_id
integer
anonymous
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_action_type_id": 0,
  • "person_id": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get campaign status check

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0
}

Response samples

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

Get campaign revisions

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_revision_id
integer

Responses

Request samples

Content type
{
  • "entry_revision_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
name
required
string
description
string
blurb
string
created
string
modified
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "name": "string",
  • "description": "string",
  • "blurb": "string",
  • "created": "string",
  • "modified": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Replicate campaign

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
name
string
description
string
blurb
string
funding_goal
number
starts
string <date-time>
ends
string <date-time>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get campaign coupons

path Parameters
entry_id
required
integer
Request Body schema:
required
coupon_id
integer

Responses

Request samples

Content type
{
  • "coupon_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Campaign home image variant

Responses

Response samples

Content type
image/*
string

Campaign explore image variant

Responses

Response samples

Content type
image/*
string

Campaign detail image variant

Responses

Response samples

Content type
image/*
string

Campaign detail large image variant

Responses

Response samples

Content type
image/*
string

Campaign profile image variant

Responses

Response samples

Content type
image/*
string

Campaign thumbnail image

Responses

Response samples

Content type
image/*
string

Campaign thumbnail large image

Responses

Response samples

Content type
image/*
string

Campaign reward image

Responses

Response samples

Content type
image/*
string

Campaign top header image

Responses

Response samples

Content type
image/*
string

Campaign progress status image

Responses

Response samples

Content type
image/*
string

Campaign thumbnail medium image

Responses

Response samples

Content type
image/*
string

Campaign thumbnail XL image

Responses

Response samples

Content type
image/*
string

Campaign large image

Responses

Response samples

Content type
image/*
string

Campaign medium image

Responses

Response samples

Content type
image/*
string

Campaign small image

Responses

Response samples

Content type
image/*
string

Get pledge level by ID

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema:
required
entry_id
integer
pledge_level_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "pledge_level_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update pledge level by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema:
required
entry_id
required
integer
pledge_level_id
required
integer
name
string
description
string
amount
number
estimated_delivery_time
string <date-time>
item_limit
integer
attributes
string
expires
string <date-time>
coupon_id
integer
priority
number

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete pledge level by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema:
required
entry_id
required
integer
pledge_level_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "pledge_level_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get shipping option by ID

path Parameters
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer
Request Body schema:
required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "pledge_level_id": 0,
  • "shipping_option_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update shipping option by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete shipping option by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer
Request Body schema:
required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "pledge_level_id": 0,
  • "shipping_option_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign resources by type

path Parameters
entry_id
required
integer
resource_type
required
string
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign resource by type

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
resource_type
required
string
Request Body schema:
required
resource_type
required
string
resource_content_type
required
string
resource
required
string
business_organization_id
integer
person_id
integer
region_id
integer

Responses

Request samples

Content type
{
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign resource by ID

path Parameters
entry_id
required
integer
resource_type
required
string
resource_id
required
integer
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Update campaign resource by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
resource_type
required
string
resource_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Delete campaign resource by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
resource_type
required
string
resource_id
required
integer
Request Body schema:
required
resource_id
required
string
resource_type
required
string
business_organization_id
integer
person_id
integer

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign resource revisions by type

path Parameters
entry_id
required
integer
resource_type
required
string
Request Body schema:
required
entry_id
required
integer
resource_revision_id
string
resource_type
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "resource_revision_id": "string",
  • "resource_type": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create campaign resource revision by type

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
resource_type
required
string
Request Body schema:
required
entry_id
required
integer
resource_type
required
string
resource_content_type
string
resource
required
string
region_id
string
label
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "region_id": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Update campaign resource revision by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
resource_type
required
string
resource_revision_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get FAQ by ID

path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update FAQ by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
name
required
string
description
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete FAQ by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get FAQ pair by ID

path Parameters
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "faq_pair_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update FAQ pair by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
question
required
string
answer
required
string
display_priority
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "faq_pair_id": 0,
  • "question": "string",
  • "answer": "string",
  • "display_priority": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Delete FAQ pair by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "faq_pair_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Get FAQ revision by ID

path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update FAQ revision by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
required
integer
name
required
string
description
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete FAQ revision by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

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:
required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "faq_pair_revision_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update FAQ pair revision by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "faq_pair_revision_id": 0,
  • "question": "string",
  • "answer": "string",
  • "display_priority": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Delete FAQ pair revision by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "faq_pair_revision_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Get campaign note by ID

path Parameters
entry_id
required
integer
entry_note_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_note_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_note_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update campaign note by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
entry_note_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_note_id
required
integer
value
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_note_id": 0,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete campaign note by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
entry_note_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_note_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_note_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign stream entry by ID

path Parameters
entry_id
required
integer
stream_id
required
integer
Request Body schema:
required
stream_id
integer
entry_id
required
integer

Responses

Request samples

Content type
{
  • "stream_id": 0,
  • "entry_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update campaign stream entry by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
stream_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "stream_id": 0,
  • "stream_type_id": 0,
  • "entry_id": 0,
  • "person_id": "string",
  • "title": "string",
  • "message": "string",
  • "published": "string",
  • "display_priority": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete campaign stream entry by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
stream_id
required
integer
Request Body schema:
required
stream_id
required
integer
entry_id
required
integer

Responses

Request samples

Content type
{
  • "stream_id": 0,
  • "entry_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get comment by ID

path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update comment by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema:
required
entry_id
required
integer
person_id
integer
comment_id
required
integer
title
string
anonymous
string
message
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "person_id": 0,
  • "comment_id": 0,
  • "title": "string",
  • "anonymous": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete comment by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get comment action by ID

path Parameters
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
required
integer
comment_action_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0,
  • "comment_action_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update comment action by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0,
  • "comment_action_id": 0,
  • "comment_action_type_id": 0,
  • "person_id": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete comment action by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0,
  • "comment_action_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign action by ID

path Parameters
entry_id
required
integer
entry_action_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_action_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_action_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update campaign action by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
entry_action_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_action_id
required
integer
entry_action_type_id
integer
person_id
integer
anonymous
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_action_id": 0,
  • "entry_action_type_id": 0,
  • "person_id": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete campaign action by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
entry_action_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_action_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_action_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get campaign revision by ID

path Parameters
entry_id
required
integer
entry_revision_id
required
integer
Request Body schema:
required
entry_revision_id
integer

Responses

Request samples

Content type
{
  • "entry_revision_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update campaign revision by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
entry_revision_id
required
integer
Request Body schema:
required
entry_revision_id
required
integer
entry_id
required
integer
name
string
description
string
blurb
string
created
string
modified
string

Responses

Request samples

Content type
{
  • "entry_revision_id": 0,
  • "entry_id": 0,
  • "name": "string",
  • "description": "string",
  • "blurb": "string",
  • "created": "string",
  • "modified": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Delete campaign revision by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
entry_revision_id
required
integer
Request Body schema:
required
entry_revision_id
required
integer
entry_id
required
integer

Responses

Request samples

Content type
{
  • "entry_revision_id": 0,
  • "entry_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Get campaign group by ID

path Parameters
group_id
required
integer
Request Body schema:
required
group_id
string

Responses

Request samples

Content type
{
  • "group_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update campaign group

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
group_id
required
string
name
required
string
description
string

Responses

Request samples

Content type
{
  • "group_id": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

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

Delete campaign group

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
group_id
required
string

Responses

Request samples

Content type
{
  • "group_id": "string"
}

Response samples

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

Update campaign

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
entry_id
required
integer
name
string
description
string
blurb
string
funding_goal
number
starts
string <date-time>
ends
string <date-time>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete campaign

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
entry_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update pledge level

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
pledge_level_id
required
integer
name
string
description
string
amount
number
estimated_delivery_time
string <date-time>
item_limit
integer
attributes
string
expires
string <date-time>
coupon_id
integer
priority
number

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete pledge level

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
pledge_level_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "pledge_level_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update pledge level shipping option

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete pledge level shipping option

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
pledge_level_id
required
integer
Request Body schema:
required
entry_id
required
integer
pledge_level_id
required
integer
shipping_option_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "pledge_level_id": 0,
  • "shipping_option_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Create campaign resource

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
resource_type
required
string
resource_content_type
required
string
resource
required
string
business_organization_id
integer
person_id
integer
region_id
integer

Responses

Request samples

Content type
{
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update campaign resource

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Delete campaign resource

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
resource_id
required
string
resource_type
required
string
business_organization_id
integer
person_id
integer

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Create campaign resource revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
resource_type
required
string
resource_content_type
string
resource
required
string
region_id
string
label
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "region_id": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Update campaign resource revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete campaign resource revision by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
resource_type
required
string
resource_revision_id
required
integer
Request Body schema:
required
entry_id
required
integer
resource_revision_id
required
string
resource_type
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "resource_revision_id": "string",
  • "resource_type": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Update campaign FAQ

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
name
required
string
description
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete campaign FAQ

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update campaign FAQ pair

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer
question
required
string
answer
required
string
display_priority
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "faq_pair_id": 0,
  • "question": "string",
  • "answer": "string",
  • "display_priority": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Delete campaign FAQ pair

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
faq_pair_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "faq_pair_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update FAQ revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
required
integer
name
required
string
description
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete FAQ revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update FAQ pair revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "faq_pair_revision_id": 0,
  • "question": "string",
  • "answer": "string",
  • "display_priority": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Delete FAQ pair revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
required
integer
faq_pair_revision_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "faq_pair_revision_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update campaign note

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_note_id
required
integer
value
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_note_id": 0,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete campaign note

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_note_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_note_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update campaign stream entry

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "stream_id": 0,
  • "stream_type_id": 0,
  • "entry_id": 0,
  • "person_id": "string",
  • "title": "string",
  • "message": "string",
  • "published": "string",
  • "display_priority": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete campaign stream entry

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
stream_id
required
integer
entry_id
required
integer

Responses

Request samples

Content type
{
  • "stream_id": 0,
  • "entry_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update campaign comment

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
person_id
integer
comment_id
required
integer
title
string
anonymous
string
message
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "person_id": 0,
  • "comment_id": 0,
  • "title": "string",
  • "anonymous": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete campaign comment

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update comment action

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0,
  • "comment_action_id": 0,
  • "comment_action_type_id": 0,
  • "person_id": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete comment action

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
comment_id
required
integer
Request Body schema:
required
entry_id
required
integer
comment_id
required
integer
comment_action_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "comment_id": 0,
  • "comment_action_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update campaign action

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_action_id
required
integer
entry_action_type_id
integer
person_id
integer
anonymous
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_action_id": 0,
  • "entry_action_type_id": 0,
  • "person_id": 0,
  • "anonymous": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete campaign action

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_action_id
required
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_action_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update campaign revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_revision_id
required
integer
entry_id
required
integer
name
string
description
string
blurb
string
created
string
modified
string

Responses

Request samples

Content type
{
  • "entry_revision_id": 0,
  • "entry_id": 0,
  • "name": "string",
  • "description": "string",
  • "blurb": "string",
  • "created": "string",
  • "modified": "string"
}

Response samples

Content type
application/json
{
  • "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
}

Delete campaign revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_revision_id
required
integer
entry_id
required
integer

Responses

Request samples

Content type
{
  • "entry_revision_id": 0,
  • "entry_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Create campaign FAQ pair

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_id
required
integer
pairs
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_id": 0,
  • "pairs": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create FAQ pair revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
faq_revision_id
required
integer
Request Body schema:
required
entry_id
required
integer
faq_revision_id
required
integer
pairs
required
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "faq_revision_id": 0,
  • "pairs": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get campaign stats

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
summary
integer
use_widgetmakr
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "summary": 0,
  • "use_widgetmakr": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update campaign settings

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
public
string

Responses

Request samples

Content type
{
  • "public": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign setting by key

path Parameters
entry_id
required
integer
setting
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update campaign setting revision

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
object (ProfileSettingRevisionUpdateRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "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"
}

Get campaign setting revision by key

path Parameters
entry_id
required
integer
setting
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get campaign widget

path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
text/html
<html><body>Widget</body></html>

Get campaign resource revision by ID

path Parameters
entry_id
required
integer
resource_type
required
string
resource_revision_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "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
}

donations

Create manual pledge

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "card_id": 1,
  • "user_id": 1
}

Create guest pledge

path Parameters
entry_id
required
integer
Request Body schema:
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 <email>
attributes
string
first_name
string
last_name
string
note
string
coupon_code
string
use_sca
string

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "card_id": 1,
  • "user_id": 1
}

Get pledges

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_backer_id
integer
inline_token
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_backer_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create pledge

path Parameters
entry_id
required
integer
Request Body schema:
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 <email>
attributes
string
charity_helper
integer
note
string
coupon_code
string
use_sca
string

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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": [ ]
}

Get campaign backers

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_backer_id
integer
filters
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_backer_id": 0,
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get pledge transactions

path Parameters
entry_id
required
integer
Request Body schema:
required
stripe_transaction_entry_backer_id
integer

Responses

Request samples

Content type
{
  • "stripe_transaction_entry_backer_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Pledge history image

Responses

Response samples

Content type
image/*
string

Get pledge by ID

path Parameters
entry_id
required
integer
entry_backer_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_backer_id
integer
inline_token
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_backer_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update pledge by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
entry_backer_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete pledge by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
entry_backer_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_backer_id
required
integer
inline_token
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_backer_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get pledge transaction by ID

path Parameters
entry_id
required
integer
stripe_transaction_entry_backer_id
required
integer
Request Body schema:
required
stripe_transaction_entry_backer_id
integer

Responses

Request samples

Content type
{
  • "stripe_transaction_entry_backer_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update pledge transaction by ID

path Parameters
entry_id
required
integer
stripe_transaction_entry_backer_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Update pledge

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete pledge

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
entry_backer_id
required
integer
inline_token
string

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "entry_backer_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Update pledge transaction

path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

payments

Create a subscription

Request Body schema:
required
token
required
string
email
required
string <email>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "subscription_plan_id": 1,
  • "name": "string",
  • "code": "string",
  • "disabled": true,
  • "created": "2020-01-01T00:00:00Z",
  • "modified": "2020-01-01T00:00:00Z"
}

Create guest Stripe account

Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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": [ ]
}

Create Stripe account

Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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": [ ]
}

Get Stripe application

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
object (ProfileStripeApplicationRetrieveRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "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"
}

Create Stripe application

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "person_id": "string",
  • "secret_key": "string",
  • "publishable_key": "string",
  • "country_id": "string",
  • "client_id": "string",
  • "skip_user_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Create Stripe connect

Request Body schema:
required
code
required
string
scope
string
state
string
name
string
description
string

Responses

Request samples

Content type
{
  • "code": "string",
  • "scope": "string",
  • "state": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Check if admin is connected to Stripe

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
object (ProfileStripeAdminConnectedRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "stripe_account_id": 1,
  • "person_id": 1,
  • "name": "string",
  • "description": "string"
}

Get Stripe connect event

Authorizations:
ApiTokenAuthSessionCookie

Responses

Get Stripe account card(s)

path Parameters
stripe_account_id
required
string
Request Body schema:
required
stripe_account_id
required
string
stripe_account_card_id
string
inline_token
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string",
  • "stripe_account_card_id": "string",
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create Stripe account card

path Parameters
stripe_account_id
required
string
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

List Stripe countries

Request Body schema:
required
object (ProfileStripeCountryRetrieveRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
[
  • {
    }
]

List Stripe currencies

Request Body schema:
required
currency_id
string
country_id
string

Responses

Request samples

Content type
{
  • "currency_id": "string",
  • "country_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Check Stripe link status

Request Body schema:
required
stripe_account_id
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string"
}

Response samples

Content type
application/json
{
  • "entry_linked": "string",
  • "entry_setting": "string"
}

Calculate charge amount

query Parameters
amount
number
Request Body schema:
required
object (ProfileStripeChargeAmountRetrieveRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "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"
}

Create direct payment intent

Request Body schema:
required
payment_method_id
required
string
amount
required
string
currency
required
string
description
string

Responses

Request samples

Content type
{
  • "payment_method_id": "string",
  • "amount": "string",
  • "currency": "string",
  • "description": "string"
}

Response samples

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

Confirm direct payment intent

Request Body schema:
required
payment_intent_id
required
string
stripe_transaction_id
string
entry_id
string
tip_transaction
string

Responses

Request samples

Content type
{
  • "payment_intent_id": "string",
  • "stripe_transaction_id": "string",
  • "entry_id": "string",
  • "tip_transaction": "string"
}

Response samples

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

Create Stripe Express account

Request Body schema:
required
object (StripeExpressCreateRequest)

Unvalidated parameters passed through to Stripe express account creation.

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{}

Create Stripe Express onboarding link

Request Body schema:
required
account_id
required
string

Responses

Request samples

Content type
{
  • "account_id": "string"
}

Response samples

Content type
application/json
{}

Verify connected Stripe account

Responses

Response samples

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

Get PayPal application

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
object (ProfilePaypalApplicationRetrieveRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "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"
}

Create PayPal application

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "person_id": "string",
  • "secret_key": "string",
  • "publishable_key": "string",
  • "country_id": "string",
  • "client_id": "string",
  • "skip_user_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

List PayPal countries

Request Body schema:
required
object (ProfilePaypalCountryRetrieveRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
[
  • {
    }
]

List PayPal currencies

Request Body schema:
required
currency_id
string
country_id
string

Responses

Request samples

Content type
{
  • "currency_id": "string",
  • "country_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create guest WidgetMakr account

Request Body schema:
required
entry_id
required
string
email
required
string <email>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Create WidgetMakr account

Request Body schema:
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 <email>

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get WidgetMakr widgets

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
widgetmakr_account_id
string

Responses

Request samples

Content type
{
  • "widgetmakr_account_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create WidgetMakr widget

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
name
required
string
api_key
required
string
widget_instance_id
required
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "api_key": "string",
  • "widget_instance_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get campaign Stripe account

path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
integer

Responses

Request samples

Content type
{
  • "entry_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get pledge transactions

path Parameters
entry_id
required
integer
Request Body schema:
required
stripe_transaction_entry_backer_id
integer

Responses

Request samples

Content type
{
  • "stripe_transaction_entry_backer_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update campaign account card

Request Body schema:
required
stripe_account_card_id
required
integer

Responses

Request samples

Content type
{
  • "stripe_account_card_id": 0
}

Response samples

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

Get Stripe account card by ID

path Parameters
stripe_account_id
required
string
stripe_account_card_id
required
string
Request Body schema:
required
stripe_account_id
required
string
stripe_account_card_id
string
inline_token
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string",
  • "stripe_account_card_id": "string",
  • "inline_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update Stripe account card

path Parameters
stripe_account_id
required
string
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete Stripe account card

path Parameters
stripe_account_id
required
string
Request Body schema:
required
stripe_account_id
required
string
stripe_account_card_id
required
string
inline_token
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string",
  • "stripe_account_card_id": "string",
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get WidgetMakr widget by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
widgetmakr_account_id
required
integer
Request Body schema:
required
widgetmakr_account_id
string

Responses

Request samples

Content type
{
  • "widgetmakr_account_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update WidgetMakr widget by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
widgetmakr_account_id
required
integer
Request Body schema:
required
widgetmakr_account_id
required
string
name
string
api_key
string
widget_instance_id
string

Responses

Request samples

Content type
{
  • "widgetmakr_account_id": "string",
  • "name": "string",
  • "api_key": "string",
  • "widget_instance_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete WidgetMakr widget by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
widgetmakr_account_id
required
integer
Request Body schema:
required
widgetmakr_account_id
required
string

Responses

Request samples

Content type
{
  • "widgetmakr_account_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get pledge transaction by ID

path Parameters
entry_id
required
integer
stripe_transaction_entry_backer_id
required
integer
Request Body schema:
required
stripe_transaction_entry_backer_id
integer

Responses

Request samples

Content type
{
  • "stripe_transaction_entry_backer_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update pledge transaction by ID

path Parameters
entry_id
required
integer
stripe_transaction_entry_backer_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Determine credit card type

Request Body schema:
required
number
string

Responses

Request samples

Content type
{
  • "number": "string"
}

Response samples

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

Determine credit card type for account

Request Body schema:
required
number
string

Responses

Request samples

Content type
{
  • "number": "string"
}

Response samples

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

Get Stripe account data

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
stripe_account_id
string
inline_token
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string",
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update Stripe account

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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": [ ]
}

Delete Stripe account

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
stripe_account_id
required
string
inline_token
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string",
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update Stripe application

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
secret_key
required
string
publishable_key
required
string
country_id
required
string
client_id
string
skip_user_id
string

Responses

Request samples

Content type
{
  • "secret_key": "string",
  • "publishable_key": "string",
  • "country_id": "string",
  • "client_id": "string",
  • "skip_user_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "stripe_account_id": 1,
  • "secret_key": "string",
  • "publishable_key": "string",
  • "client_id": 1,
  • "user_id": 1
}

Get Stripe connect data

Request Body schema:
required
stripe_account_id
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update Stripe connect

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
stripe_account_id
string
name
string
description
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete Stripe connect

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
stripe_account_id
required
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update PayPal application

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
secret_key
required
string
publishable_key
required
string
country_id
required
string
client_id
string
skip_user_id
string

Responses

Request samples

Content type
{
  • "secret_key": "string",
  • "publishable_key": "string",
  • "country_id": "string",
  • "client_id": "string",
  • "skip_user_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "paypal_account_id": 1,
  • "secret_key": "string",
  • "publishable_key": "string",
  • "client_id": 1
}

Get WidgetMakr account

Authorizations:
ApiTokenAuthSessionCookie

Responses

Response samples

Content type
application/json
{
  • "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": [ ]
}

Delete WidgetMakr account

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
widgetmakr_account_id
required
string
inline_token
string

Responses

Request samples

Content type
{
  • "widgetmakr_account_id": "string",
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Update WidgetMakr widget

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
widgetmakr_account_id
required
string
name
string
api_key
string
widget_instance_id
string

Responses

Request samples

Content type
{
  • "widgetmakr_account_id": "string",
  • "name": "string",
  • "api_key": "string",
  • "widget_instance_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete WidgetMakr widget

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
widgetmakr_account_id
required
string

Responses

Request samples

Content type
{
  • "widgetmakr_account_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Update pledge transaction

path Parameters
entry_id
required
integer
Request Body schema:
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

webhooks

Get portal webhook fingerprint

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
fingerprint
required
string

Responses

Request samples

Content type
{
  • "fingerprint": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Update portal webhook fingerprint

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
fingerprint
required
string
used
required
string

Responses

Request samples

Content type
{
  • "fingerprint": "string",
  • "used": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

admin

Disable inline person

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_id
required
integer
inline_token
required
string

Responses

Request samples

Content type
{
  • "person_id": 0,
  • "inline_token": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Check if admin is connected to Stripe

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
object (ProfileStripeAdminConnectedRequest)

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "stripe_account_id": 1,
  • "person_id": 1,
  • "name": "string",
  • "description": "string"
}

Get portal resources

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get portal settings

Request Body schema:
required
setting
string

Responses

Request samples

Content type
{
  • "setting": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Update portal settings

Request Body schema:
required
public
string

Responses

Request samples

Content type
{
  • "public": "string"
}

Response samples

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

Delete portal settings

Request Body schema:
required
public
string

Responses

Request samples

Content type
{
  • "public": "string"
}

Response samples

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

Get portal category by ID

path Parameters
category_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "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": [ ]
}

Create portal category

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
name
required
string
description
string
parent_category_id
integer
display_priority
string
attributes
string
uri_path
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "parent_category_id": 0,
  • "display_priority": "string",
  • "attributes": "string",
  • "uri_path": "string"
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get portal pages

query Parameters
page_id
integer
Request Body schema:
required
page_id
integer

Responses

Request samples

Content type
{
  • "page_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create portal page

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
name
required
string
title
string
content
string
path
string
path_text
string
meta
string
display_priority
string
published
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "title": "string",
  • "content": "string",
  • "path": "string",
  • "path_text": "string",
  • "meta": "string",
  • "display_priority": "string",
  • "published": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal coupons

Request Body schema:
required
coupon_id
integer

Responses

Request samples

Content type
{
  • "coupon_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Create portal coupon

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
code
required
string
name
required
string
description
string
discount_amount
number
discount_percentage
number
expires_date_time
string <date-time>
expires_quantity
integer

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get portal people

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
filters
string

Responses

Request samples

Content type
{
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create portal person

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
first_name
required
string
last_name
required
string
bio
string
person_status_id
string
person_type_id
string
email
required
string <email>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "id": "string",
  • "inline_token": "string",
  • "person_id": 1,
  • "token": "token_example"
}

Get portal person attributes

Request Body schema:
required
filters
string

Responses

Request samples

Content type
{
  • "filters": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get portal stats

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
entry_id
required
integer
summary
integer
use_widgetmakr
integer

Responses

Request samples

Content type
{
  • "entry_id": 0,
  • "summary": 0,
  • "use_widgetmakr": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal URI path

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
uri_path
string

Responses

Request samples

Content type
{
  • "uri_path": "string"
}

Response samples

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

Get portal campaign revisions

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
entry_revision_id
integer

Responses

Request samples

Content type
{
  • "entry_revision_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Generate account login link

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
stripe_account_id
string

Responses

Request samples

Content type
{
  • "stripe_account_id": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal people addresses

Authorizations:
ApiTokenAuthSessionCookie

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Replicate campaign

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
entry_id
required
integer
Request Body schema:
required
entry_id
required
integer
name
string
description
string
blurb
string
funding_goal
number
starts
string <date-time>
ends
string <date-time>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Get portal resources by type

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
resource_type
required
string
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create portal resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
resource_type
required
string
resource_content_type
required
string
resource
required
string
business_organization_id
integer
person_id
integer
region_id
integer

Responses

Request samples

Content type
{
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update portal resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
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

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "resource_content_type": "string",
  • "resource": "string",
  • "business_organization_id": 0,
  • "person_id": 0,
  • "region_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Delete portal resource

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
resource_id
required
string
resource_type
required
string
business_organization_id
integer
person_id
integer

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update portal category

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
category_id
required
integer
name
required
string
description
string
parent_category_id
integer
display_priority
string
attributes
string
uri_path
string

Responses

Request samples

Content type
{
  • "category_id": 0,
  • "name": "string",
  • "description": "string",
  • "parent_category_id": 0,
  • "display_priority": "string",
  • "attributes": "string",
  • "uri_path": "string"
}

Response samples

Content type
application/json
{
  • "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"
}

Delete portal category

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
category_id
required
integer

Responses

Request samples

Content type
{
  • "category_id": 0
}

Response samples

Content type
application/json
{
  • "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": [ ]
}

Get portal page by ID

path Parameters
page_id
required
integer
Request Body schema:
required
page_id
integer

Responses

Request samples

Content type
{
  • "page_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update portal page

Authorizations:
ApiTokenAuthSessionCookie
query Parameters
page_id
integer
Request Body schema:
required
page_id
required
integer
title
string
name
string
content
string
path
string
path_text
string
meta
string
display_priority
string
published
string

Responses

Request samples

Content type
{
  • "page_id": 0,
  • "title": "string",
  • "name": "string",
  • "content": "string",
  • "path": "string",
  • "path_text": "string",
  • "meta": "string",
  • "display_priority": "string",
  • "published": "string"
}

Response samples

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

Delete portal page

Authorizations:
ApiTokenAuthSessionCookie
query Parameters
page_id
integer
Request Body schema:
required
page_id
required
integer

Responses

Request samples

Content type
{
  • "page_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Get portal coupon by ID

path Parameters
coupon_id
required
integer
Request Body schema:
required
coupon_id
integer

Responses

Request samples

Content type
{
  • "coupon_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Update portal coupon

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
coupon_id
required
integer
code
string
name
string
description
string
discount_amount
number
discount_percentage
number
expires_date_time
string <date-time>
expires_quantity
integer

Responses

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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"
}

Delete portal coupon

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
coupon_id
required
integer

Responses

Request samples

Content type
{
  • "coupon_id": 0
}

Response samples

Content type
application/json
{
  • "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"
}

Update portal person

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
first_name
string
last_name
string
bio
string
person_id
required
string
person_status_id
string
person_type_id
string
email
string <email>
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

Request samples

Content type
{
  • "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

Content type
application/json
{
  • "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
}

Delete portal person

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_id
integer

Responses

Request samples

Content type
{
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "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
}

Update portal person attributes

Authorizations:
ApiTokenAuthSessionCookie
Request Body schema:
required
person_id
required
string
attributes
string

Responses

Request samples

Content type
{
  • "person_id": "string",
  • "attributes": "string"
}

Response samples

Content type
application/json
{
  • "person_id": 1,
  • "attributes": "string"
}

Get portal resource by ID

Authorizations:
ApiTokenAuthSessionCookie
path Parameters
resource_type
required
string
resource_id
required
integer
Request Body schema:
required
resource_id
string
resource_type
required
string
business_organization_id
integer
person_id
string

Responses

Request samples

Content type
{
  • "resource_id": "string",
  • "resource_type": "string",
  • "business_organization_id": 0,
  • "person_id": "string"
}

Response samples

Content type
application/json
{
  • "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
}