Introduction

Base URL:

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

This API is not authenticated.

Authentication

Example request:

curl --request POST \
    "/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"emanuel81@example.com\",
    \"password\": \"temporibus\"
}"

const url = new URL(
    "/api/v1/auth/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "emanuel81@example.com",
    "password": "temporibus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/login',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'emanuel81@example.com',
            'password' => 'temporibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "access_token": "eyJ0eXAiOiJKV1QiLC...",
    "refresh_token": "def5020045fd9405cd501731...",
    "expires_in": 3599
}

Example response (401):


{
    "error": {
        "code": 422,
        "message": "The user credentials were incorrect."
    }
}

Received response:

Request failed with error:

Example request:

curl --request POST \
    "/api/v1/auth/login/social" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"access_token\": \"eyJ0eXAiOiJKV1QiLC...\",
    \"provider\": \"facebook\",
    \"shop\": \"ducimus\",
    \"user\": \"{first_name: John, email: john@email.test}\"
}"

const url = new URL(
    "/api/v1/auth/login/social"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "access_token": "eyJ0eXAiOiJKV1QiLC...",
    "provider": "facebook",
    "shop": "ducimus",
    "user": "{first_name: John, email: john@email.test}"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/login/social',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'access_token' => 'eyJ0eXAiOiJKV1QiLC...',
            'provider' => 'facebook',
            'shop' => 'ducimus',
            'user' => '{first_name: John, email: john@email.test}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "access_token": "eyJ0eXAiOiJKV1QiLC...",
    "refresh_token": "def5020045fd9405cd501731...",
    "expires_in": 3599
}

Received response:

Request failed with error:

User registration

Example request:

curl --request POST \
    "/api/v1/auth/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"berge.tess@example.com\",
    \"password\": \"JhdVHQ%%Xyr\",
    \"phonePrefixValue\": \"naanebnrktanstbpyanrccdfgefbdwumksucik\",
    \"phoneValue\": \"leqbnyoppysargajdmwgvsuwrhngzgrywtlvndfjutezsqsyttxwqcrqflscqlufnrmoszogegemqkcm\",
    \"newsCheck\": false
}"

const url = new URL(
    "/api/v1/auth/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "berge.tess@example.com",
    "password": "JhdVHQ%%Xyr",
    "phonePrefixValue": "naanebnrktanstbpyanrccdfgefbdwumksucik",
    "phoneValue": "leqbnyoppysargajdmwgvsuwrhngzgrywtlvndfjutezsqsyttxwqcrqflscqlufnrmoszogegemqkcm",
    "newsCheck": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/register',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'berge.tess@example.com',
            'password' => 'JhdVHQ%%Xyr',
            'phonePrefixValue' => 'naanebnrktanstbpyanrccdfgefbdwumksucik',
            'phoneValue' => 'leqbnyoppysargajdmwgvsuwrhngzgrywtlvndfjutezsqsyttxwqcrqflscqlufnrmoszogegemqkcm',
            'newsCheck' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": [
        {
            "hash_id": "Wzom1j3yG7wMRZbVD89rek0g6xN5Eln2",
            "id": 72,
            "first_name": "Maybell",
            "last_name": "Feest",
            "full_name": "Maybell Feest",
            "email": "mackenzie.schowalter@oconner.com",
            "phone": null,
            "username": "",
            "nickname": "Maybell Feest",
            "subscription": false,
            "subscriptionStatus": false,
            "subscriptionGracePeriod": false,
            "rtmp_enabled": true,
            "disk_quota": null,
            "isVerified": false,
            "hasPendingInvitations": false,
            "complete_survey": false,
            "avatar": "https://cdn.streams.live/default-user-avatar.png",
            "canAddChannels": false,
            "remoteEcommerceProvider": false,
            "hasNFTsAppEnabled": false,
            "minutes": 0,
            "trial_at": null,
            "hasOveitConnection": true,
            "currency": {
                "data": {
                    "id": 1,
                    "name": "United States dollar",
                    "symbol": "$",
                    "iso_code": "USD"
                }
            },
            "apps": {
                "apps": []
            },
            "subscription_details": {
                "data": {
                    "stripe_plan": null,
                    "grace": false,
                    "canceled": false,
                    "trialing": false,
                    "trial_ends_at": null,
                    "plan": {
                        "data": {
                            "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                            "name": "Free trial",
                            "identifier": "free",
                            "order": 1,
                            "price": 0,
                            "display": true,
                            "planId": "price_free",
                            "basic": true,
                            "custom": false
                        }
                    },
                    "usage": {
                        "channels": {
                            "no": 0,
                            "from": 1,
                            "percentage": 0
                        },
                        "products": {
                            "no": 0,
                            "from": 5,
                            "percentage": 0
                        },
                        "minutes": {
                            "no": 0,
                            "from": 30,
                            "percentage": 0
                        }
                    },
                    "payment": {
                        "data": {
                            "brand": null,
                            "digits": null
                        }
                    }
                }
            },
            "features": {
                "data": [
                    {
                        "name": "30 Streaming Minutes",
                        "identifier": "streaming_minutes",
                        "value": 30
                    },
                    {
                        "name": "Live show",
                        "identifier": "liveShow",
                        "value": null
                    },
                    {
                        "name": "Live party",
                        "identifier": "liveParty",
                        "value": null
                    },
                    {
                        "name": "Chat",
                        "identifier": "chat",
                        "value": null
                    },
                    {
                        "name": "Live shopping products",
                        "identifier": "products",
                        "value": 5
                    },
                    {
                        "name": "1 Live channels",
                        "identifier": "channelsLimit",
                        "value": 1
                    },
                    {
                        "name": "Analytics",
                        "identifier": "analytics",
                        "value": null
                    },
                    {
                        "name": "Invite 1 account team members",
                        "identifier": "teamMembers",
                        "value": 1
                    },
                    {
                        "name": "Dedicated channel page on streams.live",
                        "identifier": "channel",
                        "value": null
                    },
                    {
                        "name": "Media files stored for 1 month(s)",
                        "identifier": "mediaValidity",
                        "value": 1
                    }
                ]
            }
        },
        {
            "hash_id": "YxlN38meRzWJOab5nVdoP517gVwqn2kM",
            "id": 73,
            "first_name": "Nella",
            "last_name": "Okuneva",
            "full_name": "Nella Okuneva",
            "email": "krystina36@yahoo.com",
            "phone": null,
            "username": "",
            "nickname": "Nella Okuneva",
            "subscription": false,
            "subscriptionStatus": false,
            "subscriptionGracePeriod": false,
            "rtmp_enabled": true,
            "disk_quota": null,
            "isVerified": false,
            "hasPendingInvitations": false,
            "complete_survey": false,
            "avatar": "https://cdn.streams.live/default-user-avatar.png",
            "canAddChannels": false,
            "remoteEcommerceProvider": false,
            "hasNFTsAppEnabled": false,
            "minutes": 0,
            "trial_at": null,
            "hasOveitConnection": true,
            "currency": {
                "data": {
                    "id": 1,
                    "name": "United States dollar",
                    "symbol": "$",
                    "iso_code": "USD"
                }
            },
            "apps": {
                "apps": []
            },
            "subscription_details": {
                "data": {
                    "stripe_plan": null,
                    "grace": false,
                    "canceled": false,
                    "trialing": false,
                    "trial_ends_at": null,
                    "plan": {
                        "data": {
                            "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                            "name": "Free trial",
                            "identifier": "free",
                            "order": 1,
                            "price": 0,
                            "display": true,
                            "planId": "price_free",
                            "basic": true,
                            "custom": false
                        }
                    },
                    "usage": {
                        "channels": {
                            "no": 0,
                            "from": 1,
                            "percentage": 0
                        },
                        "products": {
                            "no": 0,
                            "from": 5,
                            "percentage": 0
                        },
                        "minutes": {
                            "no": 0,
                            "from": 30,
                            "percentage": 0
                        }
                    },
                    "payment": {
                        "data": {
                            "brand": null,
                            "digits": null
                        }
                    }
                }
            },
            "features": {
                "data": [
                    {
                        "name": "30 Streaming Minutes",
                        "identifier": "streaming_minutes",
                        "value": 30
                    },
                    {
                        "name": "Live show",
                        "identifier": "liveShow",
                        "value": null
                    },
                    {
                        "name": "Live party",
                        "identifier": "liveParty",
                        "value": null
                    },
                    {
                        "name": "Chat",
                        "identifier": "chat",
                        "value": null
                    },
                    {
                        "name": "Live shopping products",
                        "identifier": "products",
                        "value": 5
                    },
                    {
                        "name": "1 Live channels",
                        "identifier": "channelsLimit",
                        "value": 1
                    },
                    {
                        "name": "Analytics",
                        "identifier": "analytics",
                        "value": null
                    },
                    {
                        "name": "Invite 1 account team members",
                        "identifier": "teamMembers",
                        "value": 1
                    },
                    {
                        "name": "Dedicated channel page on streams.live",
                        "identifier": "channel",
                        "value": null
                    },
                    {
                        "name": "Media files stored for 1 month(s)",
                        "identifier": "mediaValidity",
                        "value": 1
                    }
                ]
            }
        }
    ]
}

Received response:

Request failed with error:

Request

POST api/v1/auth/register

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

email string

Must be a valid email address. Example: berge.tess@example.com

password string

Must be at least 8 characters. Example: JhdVHQ%%Xyr

phonePrefixValue string optional

This field is required when phoneValue is != or null. Must be at least 1 character. Example: naanebnrktanstbpyanrccdfgefbdwumksucik

phoneValue string optional

Must be at least 3 characters. Example: leqbnyoppysargajdmwgvsuwrhngzgrywtlvndfjutezsqsyttxwqcrqflscqlufnrmoszogegemqkcm

newsCheck boolean optional true false

Example: false

Example request:

curl --request POST \
    "/api/v1/auth/login/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"refresh_token\": \"xyz23....\"
}"

const url = new URL(
    "/api/v1/auth/login/refresh"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "refresh_token": "xyz23...."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/login/refresh',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'refresh_token' => 'xyz23....',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "access_token": "eyJ0eXAiOiJKV1QiLC...",
    "refresh_token": "def5020045fd9405cd501731...",
    "expires_in": 3599
}

Example response (401):


{
    "error": {
        "code": 422,
        "message": "The token is invalid."
    }
}

Received response:

Request failed with error:

Logout user

Example request:

curl --request POST \
    "/api/v1/auth/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/auth/logout"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/logout',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

[Empty response]

Received response:

Request failed with error:

Request reset password by email

Example request:

curl --request POST \
    "/api/v1/auth/password/email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"fullName\": \"John Doe\",
    \"username\": \"john92\",
    \"email\": \"john@testemail.com\",
    \"password\": \"xyz23!.\"
}"

const url = new URL(
    "/api/v1/auth/password/email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "fullName": "John Doe",
    "username": "john92",
    "email": "john@testemail.com",
    "password": "xyz23!."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/password/email',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'fullName' => 'John Doe',
            'username' => 'john92',
            'email' => 'john@testemail.com',
            'password' => 'xyz23!.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/auth/password/email

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

fullName string

The entire name of the user. Example: John Doe

username string

The username of the user. Example: john92

email string

The email of the user. Example: john@testemail.com

password string

The password of the user. Example: xyz23!.

Password reset by email verification

Example request:

curl --request POST \
    "/api/v1/auth/password/reset" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"zyx...\",
    \"userEmail\": \"john@testemail.com\",
    \"password\": \"xyz23!.\"
}"

const url = new URL(
    "/api/v1/auth/password/reset"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "zyx...",
    "userEmail": "john@testemail.com",
    "password": "xyz23!."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/password/reset',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'token' => 'zyx...',
            'userEmail' => 'john@testemail.com',
            'password' => 'xyz23!.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/auth/password/reset

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

token string

The generated token sent to email. Example: zyx...

userEmail string

The current email of the account. Example: john@testemail.com

password string

The new password of the user. Example: xyz23!.

Channel

Methods to manage events for token authenticated account.

Clear cache for front office

requires authentication

Example request:

curl --request GET \
    --get "/api/v1/events/d09djkd9dw2232e2.../cache" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/d09djkd9dw2232e2.../cache"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/d09djkd9dw2232e2.../cache',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

List all channels

Example request:

curl --request GET \
    --get "/api/v1/events?orderBy=starts_at%3Bcreated_at&sortedBy=asc%3Bdesc&page=1&status=0" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events"
);

const params = {
    "orderBy": "starts_at;created_at",
    "sortedBy": "asc;desc",
    "page": "1",
    "status": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'orderBy' => 'starts_at;created_at',
            'sortedBy' => 'asc;desc',
            'page' => '1',
            'status' => '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": [
        {
            "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "name": "Test 07042023",
            "slug": "pK5A4WvhCO",
            "chat_enabled": true,
            "guest_chat_enabled": true,
            "shop_enabled": true,
            "description": "This is a test channel for current sprint",
            "location": null,
            "tickets": 0,
            "tickets_sold": 0,
            "tickets_checked_in": 0,
            "original_id": null,
            "background_url": null,
            "banner_top": "https://cdn.streams.live/event/1/cover/b82a0af3a6c2ab3f46eb102ca442f79f.jpg",
            "disk_quota": "0",
            "free_pass": 2,
            "isOwner": false,
            "isShared": false,
            "canAddMoreProducts": true,
            "streamType": 2,
            "privacy": 2,
            "questions_enabled": false,
            "starts_at": null,
            "starts_at_notz": null,
            "starts_at_date": null,
            "starts_at_time": null,
            "starts_at_status": false,
            "user_notifications": false,
            "notifications_msg": "",
            "timezone": "UTC",
            "theme": "default",
            "show_online_users": true,
            "ecommerceProviderEnabled": null,
            "nftsEnabled": false,
            "thread_id": 1,
            "last_update": "2023-04-07T10:12:36.000000Z",
            "isInstagramMultiCastAvailable": true,
            "paid": false,
            "withProducts": true,
            "owner": {
                "data": {
                    "hash_id": "JnG2XDz46KOVl3dXJkA0ajRwLykvmoeW",
                    "id": 55,
                    "username": "",
                    "nickname": "Oveit Account",
                    "subscription": false,
                    "subscriptionStatus": false,
                    "isVerified": true,
                    "avatar": "https://cdn.streams.live/default-user-avatar.png",
                    "currency": {
                        "data": {
                            "id": 1,
                            "name": "United States dollar",
                            "symbol": "$",
                            "iso_code": "USD"
                        }
                    }
                }
            },
            "stream": {
                "data": {
                    "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                    "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                    "is_live_manual": false,
                    "is_live": false,
                    "roomId": null,
                    "autojoin": false,
                    "channel": "pK5A4WvhCO",
                    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJGRkRPVWdEODZMeEFCbGdNSEZkbjQ1cWllQWZjYzkzdHgydElaTkVoVTJ3IiwiYXVkIjoidiIsImV4cCI6MTY4MDg2OTI4OCwia2lkIjoicDQ0OFAwMUN5cHAwMElDd1A2eENXVHBiM3lFa2M5eFNnb2xoV0lTNXJSRUlRIiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiJsektqQ043MDB5ZHlOMDFjbHM3NUtpUDAwUzZkaXNRNnNtNnRCVEgzdUJGcXFRIn0.olGw3MOcITWvTyGnrBHbHn8XSaP7KgbuzlnKV_WW8pyyyvhdz1_tHcDeNqBff1liJZj4a2Iy8kkHRkzTt6YpLUd2jBLsZo1LP8bqCZt-vPAC19RnMUPZxyCYG7B--8t8eNyVudNndzZwfQzBKb2LJ1LsaVx0semD5m5swLtvPJS9iOEEohpLyESRUKGmNEhokVOj6GJ_Eut7W63gXrbDzBZ7Jutmg_aQkKSddbsn5iG38tqtf_yhHxPRZku8gMCp8sfAs0qyqWypliXmqW2kBkfraj03QyugKXqImcspE2MJTuQvHsjmSIixGTmskpfNK60hab_3lOJ6xXTZIILFjA",
                    "stream_key": "ffe8860b-1d46-3c7b-204f-9bc0ca12caec",
                    "playback": {
                        "data": {
                            "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                            "playback_id": "FFDOUgD86LxABlgMHFdn45qieAfcc93tx2tIZNEhU2w"
                        }
                    },
                    "space": null,
                    "jwt": {
                        "data": []
                    }
                }
            },
            "media": {
                "data": []
            },
            "products": {
                "data": [
                    {
                        "id": 4,
                        "name": "Test",
                        "link": "https://google.com",
                        "price": 2,
                        "fixed_price": true,
                        "currency": "USD",
                        "reference": null,
                        "bumped": false,
                        "for_sale": false,
                        "hasOnlyDefaultVariant": false,
                        "isQuantityBased": false,
                        "imageSource": null,
                        "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
                        "app": null,
                        "variants": {
                            "data": []
                        },
                        "quantity": {
                            "total": null,
                            "sold": 0,
                            "available": 0,
                            "no_limit": true
                        }
                    }
                ]
            },
            "questionsCount": 0,
            "chatCount": 1,
            "following": {
                "data": []
            },
            "attributes": [],
            "features": {
                "data": [
                    {
                        "name": "30 Streaming Minutes",
                        "identifier": "streaming_minutes",
                        "value": 30
                    },
                    {
                        "name": "Live show",
                        "identifier": "liveShow",
                        "value": null
                    },
                    {
                        "name": "Live party",
                        "identifier": "liveParty",
                        "value": null
                    },
                    {
                        "name": "Chat",
                        "identifier": "chat",
                        "value": null
                    },
                    {
                        "name": "Live shopping products",
                        "identifier": "products",
                        "value": 5
                    },
                    {
                        "name": "1 Live channels",
                        "identifier": "channelsLimit",
                        "value": 1
                    },
                    {
                        "name": "Analytics",
                        "identifier": "analytics",
                        "value": null
                    },
                    {
                        "name": "Invite 1 account team members",
                        "identifier": "teamMembers",
                        "value": 1
                    },
                    {
                        "name": "Dedicated channel page on streams.live",
                        "identifier": "channel",
                        "value": null
                    },
                    {
                        "name": "Media files stored for 1 month(s)",
                        "identifier": "mediaValidity",
                        "value": 1
                    }
                ]
            },
            "minutes": 30,
            "simulcasts": {
                "data": []
            }
        },
        {
            "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "name": "Test 07042023",
            "slug": "pK5A4WvhCO",
            "chat_enabled": true,
            "guest_chat_enabled": true,
            "shop_enabled": true,
            "description": "This is a test channel for current sprint",
            "location": null,
            "tickets": 0,
            "tickets_sold": 0,
            "tickets_checked_in": 0,
            "original_id": null,
            "background_url": null,
            "banner_top": "https://cdn.streams.live/event/1/cover/b82a0af3a6c2ab3f46eb102ca442f79f.jpg",
            "disk_quota": "0",
            "free_pass": 2,
            "isOwner": false,
            "isShared": false,
            "canAddMoreProducts": true,
            "streamType": 2,
            "privacy": 2,
            "questions_enabled": false,
            "starts_at": null,
            "starts_at_notz": null,
            "starts_at_date": null,
            "starts_at_time": null,
            "starts_at_status": false,
            "user_notifications": false,
            "notifications_msg": "",
            "timezone": "UTC",
            "theme": "default",
            "show_online_users": true,
            "ecommerceProviderEnabled": null,
            "nftsEnabled": false,
            "thread_id": 1,
            "last_update": "2023-04-07T10:12:36.000000Z",
            "isInstagramMultiCastAvailable": true,
            "paid": false,
            "withProducts": true,
            "owner": {
                "data": {
                    "hash_id": "JnG2XDz46KOVl3dXJkA0ajRwLykvmoeW",
                    "id": 55,
                    "username": "",
                    "nickname": "Oveit Account",
                    "subscription": false,
                    "subscriptionStatus": false,
                    "isVerified": true,
                    "avatar": "https://cdn.streams.live/default-user-avatar.png",
                    "currency": {
                        "data": {
                            "id": 1,
                            "name": "United States dollar",
                            "symbol": "$",
                            "iso_code": "USD"
                        }
                    }
                }
            },
            "stream": {
                "data": {
                    "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                    "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                    "is_live_manual": false,
                    "is_live": false,
                    "roomId": null,
                    "autojoin": false,
                    "channel": "pK5A4WvhCO",
                    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJGRkRPVWdEODZMeEFCbGdNSEZkbjQ1cWllQWZjYzkzdHgydElaTkVoVTJ3IiwiYXVkIjoidiIsImV4cCI6MTY4MDg2OTI4OCwia2lkIjoicDQ0OFAwMUN5cHAwMElDd1A2eENXVHBiM3lFa2M5eFNnb2xoV0lTNXJSRUlRIiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiJsektqQ043MDB5ZHlOMDFjbHM3NUtpUDAwUzZkaXNRNnNtNnRCVEgzdUJGcXFRIn0.olGw3MOcITWvTyGnrBHbHn8XSaP7KgbuzlnKV_WW8pyyyvhdz1_tHcDeNqBff1liJZj4a2Iy8kkHRkzTt6YpLUd2jBLsZo1LP8bqCZt-vPAC19RnMUPZxyCYG7B--8t8eNyVudNndzZwfQzBKb2LJ1LsaVx0semD5m5swLtvPJS9iOEEohpLyESRUKGmNEhokVOj6GJ_Eut7W63gXrbDzBZ7Jutmg_aQkKSddbsn5iG38tqtf_yhHxPRZku8gMCp8sfAs0qyqWypliXmqW2kBkfraj03QyugKXqImcspE2MJTuQvHsjmSIixGTmskpfNK60hab_3lOJ6xXTZIILFjA",
                    "stream_key": "ffe8860b-1d46-3c7b-204f-9bc0ca12caec",
                    "playback": {
                        "data": {
                            "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                            "playback_id": "FFDOUgD86LxABlgMHFdn45qieAfcc93tx2tIZNEhU2w"
                        }
                    },
                    "space": null,
                    "jwt": {
                        "data": []
                    }
                }
            },
            "media": {
                "data": []
            },
            "products": {
                "data": [
                    {
                        "id": 4,
                        "name": "Test",
                        "link": "https://google.com",
                        "price": 2,
                        "fixed_price": true,
                        "currency": "USD",
                        "reference": null,
                        "bumped": false,
                        "for_sale": false,
                        "hasOnlyDefaultVariant": false,
                        "isQuantityBased": false,
                        "imageSource": null,
                        "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
                        "app": null,
                        "variants": {
                            "data": []
                        },
                        "quantity": {
                            "total": null,
                            "sold": 0,
                            "available": 0,
                            "no_limit": true
                        }
                    }
                ]
            },
            "questionsCount": 0,
            "chatCount": 1,
            "following": {
                "data": []
            },
            "attributes": [],
            "features": {
                "data": [
                    {
                        "name": "30 Streaming Minutes",
                        "identifier": "streaming_minutes",
                        "value": 30
                    },
                    {
                        "name": "Live show",
                        "identifier": "liveShow",
                        "value": null
                    },
                    {
                        "name": "Live party",
                        "identifier": "liveParty",
                        "value": null
                    },
                    {
                        "name": "Chat",
                        "identifier": "chat",
                        "value": null
                    },
                    {
                        "name": "Live shopping products",
                        "identifier": "products",
                        "value": 5
                    },
                    {
                        "name": "1 Live channels",
                        "identifier": "channelsLimit",
                        "value": 1
                    },
                    {
                        "name": "Analytics",
                        "identifier": "analytics",
                        "value": null
                    },
                    {
                        "name": "Invite 1 account team members",
                        "identifier": "teamMembers",
                        "value": 1
                    },
                    {
                        "name": "Dedicated channel page on streams.live",
                        "identifier": "channel",
                        "value": null
                    },
                    {
                        "name": "Media files stored for 1 month(s)",
                        "identifier": "mediaValidity",
                        "value": 1
                    }
                ]
            },
            "minutes": 30,
            "simulcasts": {
                "data": []
            }
        }
    ]
}

Received response:

Request failed with error:

Request

GET api/v1/events

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Query Parameters

orderBy string optional

Field to order by. Example: starts_at;created_at

sortedBy string optional

Direction to order. asc or desc. Example: asc;desc

page integer optional

Page to display. 10 items per page. Example: 1

status integer optional

Filter events by state. 1 for past events, 2 for deleted ones and 0 for active ones. Example: 0

Forced stop

Example request:

curl --request POST \
    "/api/v1/events/nisi/complete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/nisi/complete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/nisi/complete',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Create new channel

requires authentication

Example request:

curl --request POST \
    "/api/v1/events" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"wwkxjfqk\",
    \"starts_at\": \"2023-04-10 09:59:47\"
}"

const url = new URL(
    "/api/v1/events"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "wwkxjfqk",
    "starts_at": "2023-04-10 09:59:47"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'wwkxjfqk',
            'starts_at' => '2023-04-10 09:59:47',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "name": "Test 07042023",
        "slug": "pK5A4WvhCO",
        "chat_enabled": true,
        "guest_chat_enabled": true,
        "shop_enabled": true,
        "description": "This is a test channel for current sprint",
        "location": null,
        "tickets": 0,
        "tickets_sold": 0,
        "tickets_checked_in": 0,
        "original_id": null,
        "background_url": null,
        "banner_top": "https://cdn.streams.live/event/1/cover/b82a0af3a6c2ab3f46eb102ca442f79f.jpg",
        "disk_quota": "0",
        "free_pass": 2,
        "isOwner": false,
        "isShared": false,
        "canAddMoreProducts": true,
        "streamType": 2,
        "privacy": 2,
        "questions_enabled": false,
        "starts_at": null,
        "starts_at_notz": null,
        "starts_at_date": null,
        "starts_at_time": null,
        "starts_at_status": false,
        "user_notifications": false,
        "notifications_msg": "",
        "timezone": "UTC",
        "theme": "default",
        "show_online_users": true,
        "ecommerceProviderEnabled": null,
        "nftsEnabled": false,
        "thread_id": 1,
        "last_update": "2023-04-07T10:12:36.000000Z",
        "isInstagramMultiCastAvailable": true,
        "paid": false,
        "withProducts": true,
        "owner": {
            "data": {
                "hash_id": "JnG2XDz46KOVl3dXJkA0ajRwLykvmoeW",
                "id": 55,
                "username": "",
                "nickname": "Oveit Account",
                "subscription": false,
                "subscriptionStatus": false,
                "isVerified": true,
                "avatar": "https://cdn.streams.live/default-user-avatar.png",
                "currency": {
                    "data": {
                        "id": 1,
                        "name": "United States dollar",
                        "symbol": "$",
                        "iso_code": "USD"
                    }
                }
            }
        },
        "stream": {
            "data": {
                "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                "is_live_manual": false,
                "is_live": false,
                "roomId": null,
                "autojoin": false,
                "channel": "pK5A4WvhCO",
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJGRkRPVWdEODZMeEFCbGdNSEZkbjQ1cWllQWZjYzkzdHgydElaTkVoVTJ3IiwiYXVkIjoidiIsImV4cCI6MTY4MDg2OTI4OCwia2lkIjoicDQ0OFAwMUN5cHAwMElDd1A2eENXVHBiM3lFa2M5eFNnb2xoV0lTNXJSRUlRIiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiJsektqQ043MDB5ZHlOMDFjbHM3NUtpUDAwUzZkaXNRNnNtNnRCVEgzdUJGcXFRIn0.olGw3MOcITWvTyGnrBHbHn8XSaP7KgbuzlnKV_WW8pyyyvhdz1_tHcDeNqBff1liJZj4a2Iy8kkHRkzTt6YpLUd2jBLsZo1LP8bqCZt-vPAC19RnMUPZxyCYG7B--8t8eNyVudNndzZwfQzBKb2LJ1LsaVx0semD5m5swLtvPJS9iOEEohpLyESRUKGmNEhokVOj6GJ_Eut7W63gXrbDzBZ7Jutmg_aQkKSddbsn5iG38tqtf_yhHxPRZku8gMCp8sfAs0qyqWypliXmqW2kBkfraj03QyugKXqImcspE2MJTuQvHsjmSIixGTmskpfNK60hab_3lOJ6xXTZIILFjA",
                "stream_key": "ffe8860b-1d46-3c7b-204f-9bc0ca12caec",
                "playback": {
                    "data": {
                        "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                        "playback_id": "FFDOUgD86LxABlgMHFdn45qieAfcc93tx2tIZNEhU2w"
                    }
                },
                "space": null,
                "jwt": {
                    "data": []
                }
            }
        },
        "media": {
            "data": []
        },
        "products": {
            "data": [
                {
                    "id": 4,
                    "name": "Test",
                    "link": "https://google.com",
                    "price": 2,
                    "fixed_price": true,
                    "currency": "USD",
                    "reference": null,
                    "bumped": false,
                    "for_sale": false,
                    "hasOnlyDefaultVariant": false,
                    "isQuantityBased": false,
                    "imageSource": null,
                    "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
                    "app": null,
                    "variants": {
                        "data": []
                    },
                    "quantity": {
                        "total": null,
                        "sold": 0,
                        "available": 0,
                        "no_limit": true
                    }
                }
            ]
        },
        "questionsCount": 0,
        "chatCount": 1,
        "following": {
            "data": []
        },
        "attributes": [],
        "features": {
            "data": [
                {
                    "name": "30 Streaming Minutes",
                    "identifier": "streaming_minutes",
                    "value": 30
                },
                {
                    "name": "Live show",
                    "identifier": "liveShow",
                    "value": null
                },
                {
                    "name": "Live party",
                    "identifier": "liveParty",
                    "value": null
                },
                {
                    "name": "Chat",
                    "identifier": "chat",
                    "value": null
                },
                {
                    "name": "Live shopping products",
                    "identifier": "products",
                    "value": 5
                },
                {
                    "name": "1 Live channels",
                    "identifier": "channelsLimit",
                    "value": 1
                },
                {
                    "name": "Analytics",
                    "identifier": "analytics",
                    "value": null
                },
                {
                    "name": "Invite 1 account team members",
                    "identifier": "teamMembers",
                    "value": 1
                },
                {
                    "name": "Dedicated channel page on streams.live",
                    "identifier": "channel",
                    "value": null
                },
                {
                    "name": "Media files stored for 1 month(s)",
                    "identifier": "mediaValidity",
                    "value": 1
                }
            ]
        },
        "minutes": 30,
        "simulcasts": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

Must match the regex /^[\w-\s]+$/u. Must be at least 3 characters. Must not be greater than 255 characters. Example: wwkxjfqk

starts_at string optional

Must be a valid date in the format Y-m-d H:i:s. Example: 2023-04-10 09:59:47

Show channels details

requires authentication

Example request:

curl --request GET \
    --get "/api/v1/events/soluta" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/soluta"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/soluta',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "name": "Test 07042023",
        "slug": "pK5A4WvhCO",
        "chat_enabled": true,
        "guest_chat_enabled": true,
        "shop_enabled": true,
        "description": "This is a test channel for current sprint",
        "location": null,
        "tickets": 0,
        "tickets_sold": 0,
        "tickets_checked_in": 0,
        "original_id": null,
        "background_url": null,
        "banner_top": "https://cdn.streams.live/event/1/cover/b82a0af3a6c2ab3f46eb102ca442f79f.jpg",
        "disk_quota": "0",
        "free_pass": 2,
        "isOwner": false,
        "isShared": false,
        "canAddMoreProducts": true,
        "streamType": 2,
        "privacy": 2,
        "questions_enabled": false,
        "starts_at": null,
        "starts_at_notz": null,
        "starts_at_date": null,
        "starts_at_time": null,
        "starts_at_status": false,
        "user_notifications": false,
        "notifications_msg": "",
        "timezone": "UTC",
        "theme": "default",
        "show_online_users": true,
        "ecommerceProviderEnabled": null,
        "nftsEnabled": false,
        "thread_id": 1,
        "last_update": "2023-04-07T10:12:36.000000Z",
        "isInstagramMultiCastAvailable": true,
        "paid": false,
        "withProducts": true,
        "owner": {
            "data": {
                "hash_id": "JnG2XDz46KOVl3dXJkA0ajRwLykvmoeW",
                "id": 55,
                "username": "",
                "nickname": "Oveit Account",
                "subscription": false,
                "subscriptionStatus": false,
                "isVerified": true,
                "avatar": "https://cdn.streams.live/default-user-avatar.png",
                "currency": {
                    "data": {
                        "id": 1,
                        "name": "United States dollar",
                        "symbol": "$",
                        "iso_code": "USD"
                    }
                }
            }
        },
        "stream": {
            "data": {
                "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                "is_live_manual": false,
                "is_live": false,
                "roomId": null,
                "autojoin": false,
                "channel": "pK5A4WvhCO",
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJGRkRPVWdEODZMeEFCbGdNSEZkbjQ1cWllQWZjYzkzdHgydElaTkVoVTJ3IiwiYXVkIjoidiIsImV4cCI6MTY4MDg2OTI4OCwia2lkIjoicDQ0OFAwMUN5cHAwMElDd1A2eENXVHBiM3lFa2M5eFNnb2xoV0lTNXJSRUlRIiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiJsektqQ043MDB5ZHlOMDFjbHM3NUtpUDAwUzZkaXNRNnNtNnRCVEgzdUJGcXFRIn0.olGw3MOcITWvTyGnrBHbHn8XSaP7KgbuzlnKV_WW8pyyyvhdz1_tHcDeNqBff1liJZj4a2Iy8kkHRkzTt6YpLUd2jBLsZo1LP8bqCZt-vPAC19RnMUPZxyCYG7B--8t8eNyVudNndzZwfQzBKb2LJ1LsaVx0semD5m5swLtvPJS9iOEEohpLyESRUKGmNEhokVOj6GJ_Eut7W63gXrbDzBZ7Jutmg_aQkKSddbsn5iG38tqtf_yhHxPRZku8gMCp8sfAs0qyqWypliXmqW2kBkfraj03QyugKXqImcspE2MJTuQvHsjmSIixGTmskpfNK60hab_3lOJ6xXTZIILFjA",
                "stream_key": "ffe8860b-1d46-3c7b-204f-9bc0ca12caec",
                "playback": {
                    "data": {
                        "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                        "playback_id": "FFDOUgD86LxABlgMHFdn45qieAfcc93tx2tIZNEhU2w"
                    }
                },
                "space": null,
                "jwt": {
                    "data": []
                }
            }
        },
        "media": {
            "data": []
        },
        "products": {
            "data": [
                {
                    "id": 4,
                    "name": "Test",
                    "link": "https://google.com",
                    "price": 2,
                    "fixed_price": true,
                    "currency": "USD",
                    "reference": null,
                    "bumped": false,
                    "for_sale": false,
                    "hasOnlyDefaultVariant": false,
                    "isQuantityBased": false,
                    "imageSource": null,
                    "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
                    "app": null,
                    "variants": {
                        "data": []
                    },
                    "quantity": {
                        "total": null,
                        "sold": 0,
                        "available": 0,
                        "no_limit": true
                    }
                }
            ]
        },
        "questionsCount": 0,
        "chatCount": 1,
        "following": {
            "data": []
        },
        "attributes": [],
        "features": {
            "data": [
                {
                    "name": "30 Streaming Minutes",
                    "identifier": "streaming_minutes",
                    "value": 30
                },
                {
                    "name": "Live show",
                    "identifier": "liveShow",
                    "value": null
                },
                {
                    "name": "Live party",
                    "identifier": "liveParty",
                    "value": null
                },
                {
                    "name": "Chat",
                    "identifier": "chat",
                    "value": null
                },
                {
                    "name": "Live shopping products",
                    "identifier": "products",
                    "value": 5
                },
                {
                    "name": "1 Live channels",
                    "identifier": "channelsLimit",
                    "value": 1
                },
                {
                    "name": "Analytics",
                    "identifier": "analytics",
                    "value": null
                },
                {
                    "name": "Invite 1 account team members",
                    "identifier": "teamMembers",
                    "value": 1
                },
                {
                    "name": "Dedicated channel page on streams.live",
                    "identifier": "channel",
                    "value": null
                },
                {
                    "name": "Media files stored for 1 month(s)",
                    "identifier": "mediaValidity",
                    "value": 1
                }
            ]
        },
        "minutes": 30,
        "simulcasts": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Update channel details.

Example request:

curl --request PUT \
    "/api/v1/events/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"wtw\",
    \"description\": \"Dolor inventore dolore pariatur enim incidunt dolorem dolor.\",
    \"chat_enabled\": true,
    \"show_online_users\": false,
    \"guest_chat_enabled\": true,
    \"shop_enabled\": false,
    \"simulcast\": false,
    \"free_pass\": false,
    \"stream_type\": 115898.52923136,
    \"privacy\": \"2\",
    \"questionsEnabled\": false,
    \"starts_at\": \"2023-04-10T09:59:47\",
    \"starts_at_status\": false,
    \"starts_at_time\": \"09:59:47\",
    \"starts_at_date\": \"2023-04-10\",
    \"add_step\": 189586.20524339,
    \"locale\": \"haw_US\",
    \"user_notifications\": false,
    \"notifications_msg\": \"et\",
    \"slug\": \"azdt\",
    \"attributes\": {
        \"userEmailNotifications\": true,
        \"userSMSNotifications\": false,
        \"productAtcLabel\": \"ex\",
        \"productCtaLabel\": \"culpa\",
        \"productSectionLabel\": \"quas\",
        \"channelOriginUrl\": \"https:\\/\\/howell.net\\/saepe-optio-consequatur-aliquid-omnis.html\"
    }
}"

const url = new URL(
    "/api/v1/events/16"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "wtw",
    "description": "Dolor inventore dolore pariatur enim incidunt dolorem dolor.",
    "chat_enabled": true,
    "show_online_users": false,
    "guest_chat_enabled": true,
    "shop_enabled": false,
    "simulcast": false,
    "free_pass": false,
    "stream_type": 115898.52923136,
    "privacy": "2",
    "questionsEnabled": false,
    "starts_at": "2023-04-10T09:59:47",
    "starts_at_status": false,
    "starts_at_time": "09:59:47",
    "starts_at_date": "2023-04-10",
    "add_step": 189586.20524339,
    "locale": "haw_US",
    "user_notifications": false,
    "notifications_msg": "et",
    "slug": "azdt",
    "attributes": {
        "userEmailNotifications": true,
        "userSMSNotifications": false,
        "productAtcLabel": "ex",
        "productCtaLabel": "culpa",
        "productSectionLabel": "quas",
        "channelOriginUrl": "https:\/\/howell.net\/saepe-optio-consequatur-aliquid-omnis.html"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/events/16',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'wtw',
            'description' => 'Dolor inventore dolore pariatur enim incidunt dolorem dolor.',
            'chat_enabled' => true,
            'show_online_users' => false,
            'guest_chat_enabled' => true,
            'shop_enabled' => false,
            'simulcast' => false,
            'free_pass' => false,
            'stream_type' => 115898.52923136,
            'privacy' => '2',
            'questionsEnabled' => false,
            'starts_at' => '2023-04-10T09:59:47',
            'starts_at_status' => false,
            'starts_at_time' => '09:59:47',
            'starts_at_date' => '2023-04-10',
            'add_step' => 189586.20524339,
            'locale' => 'haw_US',
            'user_notifications' => false,
            'notifications_msg' => 'et',
            'slug' => 'azdt',
            'attributes' => [
                'userEmailNotifications' => true,
                'userSMSNotifications' => false,
                'productAtcLabel' => 'ex',
                'productCtaLabel' => 'culpa',
                'productSectionLabel' => 'quas',
                'channelOriginUrl' => 'https://howell.net/saepe-optio-consequatur-aliquid-omnis.html',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "name": "Test 07042023",
        "slug": "pK5A4WvhCO",
        "chat_enabled": true,
        "guest_chat_enabled": true,
        "shop_enabled": true,
        "description": "This is a test channel for current sprint",
        "location": null,
        "tickets": 0,
        "tickets_sold": 0,
        "tickets_checked_in": 0,
        "original_id": null,
        "background_url": null,
        "banner_top": "https://cdn.streams.live/event/1/cover/b82a0af3a6c2ab3f46eb102ca442f79f.jpg",
        "disk_quota": "0",
        "free_pass": 2,
        "isOwner": false,
        "isShared": false,
        "canAddMoreProducts": true,
        "streamType": 2,
        "privacy": 2,
        "questions_enabled": false,
        "starts_at": null,
        "starts_at_notz": null,
        "starts_at_date": null,
        "starts_at_time": null,
        "starts_at_status": false,
        "user_notifications": false,
        "notifications_msg": "",
        "timezone": "UTC",
        "theme": "default",
        "show_online_users": true,
        "ecommerceProviderEnabled": null,
        "nftsEnabled": false,
        "thread_id": 1,
        "last_update": "2023-04-07T10:12:36.000000Z",
        "isInstagramMultiCastAvailable": true,
        "paid": false,
        "withProducts": true,
        "owner": {
            "data": {
                "hash_id": "JnG2XDz46KOVl3dXJkA0ajRwLykvmoeW",
                "id": 55,
                "username": "",
                "nickname": "Oveit Account",
                "subscription": false,
                "subscriptionStatus": false,
                "isVerified": true,
                "avatar": "https://cdn.streams.live/default-user-avatar.png",
                "currency": {
                    "data": {
                        "id": 1,
                        "name": "United States dollar",
                        "symbol": "$",
                        "iso_code": "USD"
                    }
                }
            }
        },
        "stream": {
            "data": {
                "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                "is_live_manual": false,
                "is_live": false,
                "roomId": null,
                "autojoin": false,
                "channel": "pK5A4WvhCO",
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJGRkRPVWdEODZMeEFCbGdNSEZkbjQ1cWllQWZjYzkzdHgydElaTkVoVTJ3IiwiYXVkIjoidiIsImV4cCI6MTY4MDg2OTI4OCwia2lkIjoicDQ0OFAwMUN5cHAwMElDd1A2eENXVHBiM3lFa2M5eFNnb2xoV0lTNXJSRUlRIiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiJsektqQ043MDB5ZHlOMDFjbHM3NUtpUDAwUzZkaXNRNnNtNnRCVEgzdUJGcXFRIn0.olGw3MOcITWvTyGnrBHbHn8XSaP7KgbuzlnKV_WW8pyyyvhdz1_tHcDeNqBff1liJZj4a2Iy8kkHRkzTt6YpLUd2jBLsZo1LP8bqCZt-vPAC19RnMUPZxyCYG7B--8t8eNyVudNndzZwfQzBKb2LJ1LsaVx0semD5m5swLtvPJS9iOEEohpLyESRUKGmNEhokVOj6GJ_Eut7W63gXrbDzBZ7Jutmg_aQkKSddbsn5iG38tqtf_yhHxPRZku8gMCp8sfAs0qyqWypliXmqW2kBkfraj03QyugKXqImcspE2MJTuQvHsjmSIixGTmskpfNK60hab_3lOJ6xXTZIILFjA",
                "stream_key": "ffe8860b-1d46-3c7b-204f-9bc0ca12caec",
                "playback": {
                    "data": {
                        "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                        "playback_id": "FFDOUgD86LxABlgMHFdn45qieAfcc93tx2tIZNEhU2w"
                    }
                },
                "space": null,
                "jwt": {
                    "data": []
                }
            }
        },
        "media": {
            "data": []
        },
        "products": {
            "data": [
                {
                    "id": 4,
                    "name": "Test",
                    "link": "https://google.com",
                    "price": 2,
                    "fixed_price": true,
                    "currency": "USD",
                    "reference": null,
                    "bumped": false,
                    "for_sale": false,
                    "hasOnlyDefaultVariant": false,
                    "isQuantityBased": false,
                    "imageSource": null,
                    "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
                    "app": null,
                    "variants": {
                        "data": []
                    },
                    "quantity": {
                        "total": null,
                        "sold": 0,
                        "available": 0,
                        "no_limit": true
                    }
                }
            ]
        },
        "questionsCount": 0,
        "chatCount": 1,
        "following": {
            "data": []
        },
        "attributes": [],
        "features": {
            "data": [
                {
                    "name": "30 Streaming Minutes",
                    "identifier": "streaming_minutes",
                    "value": 30
                },
                {
                    "name": "Live show",
                    "identifier": "liveShow",
                    "value": null
                },
                {
                    "name": "Live party",
                    "identifier": "liveParty",
                    "value": null
                },
                {
                    "name": "Chat",
                    "identifier": "chat",
                    "value": null
                },
                {
                    "name": "Live shopping products",
                    "identifier": "products",
                    "value": 5
                },
                {
                    "name": "1 Live channels",
                    "identifier": "channelsLimit",
                    "value": 1
                },
                {
                    "name": "Analytics",
                    "identifier": "analytics",
                    "value": null
                },
                {
                    "name": "Invite 1 account team members",
                    "identifier": "teamMembers",
                    "value": 1
                },
                {
                    "name": "Dedicated channel page on streams.live",
                    "identifier": "channel",
                    "value": null
                },
                {
                    "name": "Media files stored for 1 month(s)",
                    "identifier": "mediaValidity",
                    "value": 1
                }
            ]
        },
        "minutes": 30,
        "simulcasts": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Request

PUT api/v1/events/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id integer

The id of the channel. Example: Example: 16

Body Parameters

name string optional

Must be between 3 and 60 characters. Example: wtw

description string optional

Must be between 5 and 10000 characters. Example: Dolor inventore dolore pariatur enim incidunt dolorem dolor.

chat_enabled boolean optional true false

Example: true

show_online_users boolean optional true false

Example: false

guest_chat_enabled boolean optional true false

Example: true

shop_enabled boolean optional true false

Example: false

simulcast boolean optional true false

Example: false

free_pass boolean optional true false

Example: false

stream_type number optional

Example: 115898.52923136

privacy number optional

Must be one of 0, 1, or 2. Example: 2

questionsEnabled boolean optional true false

Example: false

starts_at string optional

Must be a valid date. Example: 2023-04-10T09:59:47

starts_at_status boolean optional true false

Example: false

starts_at_time string optional

Must be a valid date in the format H:i:s. Example: 09:59:47

starts_at_date string optional

Must be a valid date in the format Y-m-d. Example: 2023-04-10

add_step number optional

Example: 189586.20524339

locale string optional

Example: haw_US

user_notifications boolean optional true false

Example: false

notifications_msg string optional

Example: et

slug string optional

Must contain only letters, numbers, dashes and underscores. Must be between 4 and 15 characters. Example: azdt

attributes object optional

userEmailNotifications boolean optional true false

Example: true

userSMSNotifications boolean optional true false

Example: false

productAtcLabel string optional

Example: ex

productCtaLabel string optional

Example: culpa

productSectionLabel string optional

Example: quas

channelOriginUrl string optional

Must be a valid URL. Example: https://howell.net/saepe-optio-consequatur-aliquid-omnis.html

channelMainColor string optional

Delete a channel

Example request:

curl --request DELETE \
    "/api/v1/events/d09djkd9dw2232e2..." \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/d09djkd9dw2232e2..."
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/events/d09djkd9dw2232e2...',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
id: d09djkd9dw2232e2...,
code: 200
}

Received response:

Request failed with error:

Channel Medias

DELETE api/v1/events/media/{id}

Example request:

curl --request DELETE \
    "/api/v1/events/media/est" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/media/est"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/events/media/est',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/events/{id}/media/add

Example request:

curl --request POST \
    "/api/v1/events/iusto/media/add" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": {
        \"extension\": \"video\\/mpeg\",
        \"filename\": \"aizjcnmgpnzim\",
        \"size\": 0
    }
}"

const url = new URL(
    "/api/v1/events/iusto/media/add"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file": {
        "extension": "video\/mpeg",
        "filename": "aizjcnmgpnzim",
        "size": 0
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/iusto/media/add',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'file' => [
                'extension' => 'video/mpeg',
                'filename' => 'aizjcnmgpnzim',
                'size' => 0.0,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events/{id}/media/add

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

Example: iusto

Body Parameters

file object optional

extension string

Must be one of video/mp4, video/mpeg, or video/webm. Example: video/mpeg

filename string

Must be at least 3 characters. Must not be greater than 200 characters. Example: aizjcnmgpnzim

size number

Example: 0

POST api/v1/events/media/{id}/sync

Example request:

curl --request POST \
    "/api/v1/events/media/consequatur/sync" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/media/consequatur/sync"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/media/consequatur/sync',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/events/media/{id}/change-background

Example request:

curl --request POST \
    "/api/v1/events/media/nulla/change-background" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/media/nulla/change-background"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/media/nulla/change-background',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Change event cover

Example request:

curl --request POST \
    "/api/v1/events/media/ut/banners" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/media/ut/banners"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/media/ut/banners',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/events/{id}/media

Example request:

curl --request GET \
    --get "/api/v1/events/omnis/media" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/omnis/media"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/omnis/media',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Update event media

Example request:

curl --request PUT \
    "/api/v1/events/media/quibusdam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/media/quibusdam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/events/media/quibusdam',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Delete event cover

Example request:

curl --request DELETE \
    "/api/v1/events/media/maxime/banners/clear" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/media/maxime/banners/clear"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/events/media/maxime/banners/clear',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PATCH api/v1/events/media/{id}/trim

Example request:

curl --request PATCH \
    "/api/v1/events/media/adipisci/trim" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start\": 112005.1498123,
    \"end\": 785.99142108
}"

const url = new URL(
    "/api/v1/events/media/adipisci/trim"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start": 112005.1498123,
    "end": 785.99142108
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    '/api/v1/events/media/adipisci/trim',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'start' => 112005.1498123,
            'end' => 785.99142108,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

PATCH api/v1/events/media/{id}/trim

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

Example: adipisci

Body Parameters

start number

Example: 112005.1498123

end number

Example: 785.99142108

GET api/v1/events/media/{id}/download

Example request:

curl --request GET \
    --get "/api/v1/events/media/velit/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/media/velit/download"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/media/velit/download',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Channel Products

GET api/v1/events/{id}/user-products

Example request:

curl --request GET \
    --get "/api/v1/events/voluptas/user-products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/voluptas/user-products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/voluptas/user-products',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get products of a channel

Example request:

curl --request GET \
    --get "/api/v1/events/345/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/345/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/345/products',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": [
        {
            "id": 4,
            "name": "Test",
            "link": "https://google.com",
            "price": 2,
            "fixed_price": true,
            "currency": "USD",
            "reference": null,
            "bumped": false,
            "for_sale": false,
            "hasOnlyDefaultVariant": false,
            "isQuantityBased": false,
            "imageSource": null,
            "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
            "app": null,
            "variants": {
                "data": []
            },
            "quantity": {
                "total": null,
                "sold": 0,
                "available": 0,
                "no_limit": true
            }
        },
        {
            "id": 4,
            "name": "Test",
            "link": "https://google.com",
            "price": 2,
            "fixed_price": true,
            "currency": "USD",
            "reference": null,
            "bumped": false,
            "for_sale": false,
            "hasOnlyDefaultVariant": false,
            "isQuantityBased": false,
            "imageSource": null,
            "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
            "app": null,
            "variants": {
                "data": []
            },
            "quantity": {
                "total": null,
                "sold": 0,
                "available": 0,
                "no_limit": true
            }
        }
    ]
}

Received response:

Request failed with error:

Add product to channel.

Example request:

curl --request POST \
    "/api/v1/events/ex/products/voluptas/enable" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "image=@/tmp/phpBMiFhb"

const url = new URL(
    "/api/v1/events/ex/products/voluptas/enable"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/ex/products/voluptas/enable',
    [
        'headers' => [
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'image',
                'contents' => fopen('/tmp/phpBMiFhb', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 4,
        "name": "Test",
        "link": "https://google.com",
        "price": 2,
        "fixed_price": true,
        "currency": "USD",
        "reference": null,
        "bumped": false,
        "for_sale": false,
        "hasOnlyDefaultVariant": false,
        "isQuantityBased": false,
        "imageSource": null,
        "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
        "app": null,
        "variants": {
            "data": []
        },
        "quantity": {
            "total": null,
            "sold": 0,
            "available": 0,
            "no_limit": true
        }
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events/{id}/products/{productId}/enable

Headers

Content-Type

Example: multipart/form-data

Accept

Example: application/json

URL Parameters

id string

The ID of the channel. Example: ex

productId string

The ID of the product. Example: voluptas

Body Parameters

image file

The image for the thumbnail. Example: /tmp/phpBMiFhb

Add variant to channel

Example request:

curl --request PUT \
    "/api/v1/events/laboriosam/variants" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reference\": 136.6,
    \"product_id\": 402965.0811
}"

const url = new URL(
    "/api/v1/events/laboriosam/variants"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reference": 136.6,
    "product_id": 402965.0811
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/events/laboriosam/variants',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'reference' => 136.6,
            'product_id' => 402965.0811,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

PUT api/v1/events/{eventId}/variants

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: laboriosam

Body Parameters

reference number

Example: 136.6

product_id number

Example: 402965.0811

Remove a variant from channel

Example request:

curl --request DELETE \
    "/api/v1/events/voluptate/variant/animi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/voluptate/variant/animi"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/events/voluptate/variant/animi',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Remove product from channel

Example request:

curl --request POST \
    "/api/v1/events/ullam/products/nulla/disable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/ullam/products/nulla/disable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/ullam/products/nulla/disable',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": [
        {
            "id": 4,
            "name": "Test",
            "link": "https://google.com",
            "price": 2,
            "fixed_price": true,
            "currency": "USD",
            "reference": null,
            "bumped": false,
            "for_sale": false,
            "hasOnlyDefaultVariant": false,
            "isQuantityBased": false,
            "imageSource": null,
            "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
            "app": null,
            "variants": {
                "data": []
            },
            "quantity": {
                "total": null,
                "sold": 0,
                "available": 0,
                "no_limit": true
            }
        },
        {
            "id": 4,
            "name": "Test",
            "link": "https://google.com",
            "price": 2,
            "fixed_price": true,
            "currency": "USD",
            "reference": null,
            "bumped": false,
            "for_sale": false,
            "hasOnlyDefaultVariant": false,
            "isQuantityBased": false,
            "imageSource": null,
            "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
            "app": null,
            "variants": {
                "data": []
            },
            "quantity": {
                "total": null,
                "sold": 0,
                "available": 0,
                "no_limit": true
            }
        }
    ]
}

Received response:

Request failed with error:

Sort products

Example request:

curl --request PATCH \
    "/api/v1/events/quasi/products/order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order\": [
        2669058
    ]
}"

const url = new URL(
    "/api/v1/events/quasi/products/order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order": [
        2669058
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    '/api/v1/events/quasi/products/order',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'order' => [
                2669058.0,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Create a product at user level and get all products back

requires authentication

Example request:

curl --request POST \
    "/api/v1/profile/nfts/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"at\",
    \"price\": \"nihil\",
    \"quantity\": 45,
    \"image\": [
        \"asperiores\"
    ],
    \"link\": \"similique\"
}"

const url = new URL(
    "/api/v1/profile/nfts/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "at",
    "price": "nihil",
    "quantity": 45,
    "image": [
        "asperiores"
    ],
    "link": "similique"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile/nfts/create',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'at',
            'price' => 'nihil',
            'quantity' => 45,
            'image' => [
                'asperiores',
            ],
            'link' => 'similique',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/profile/nfts/create

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

Example: at

price decimal optional

Example: nihil

quantity number optional

Must be at least 0. Example: 45

image string[]

Array of images files: jpeg,png,jpg,gif',

link string

Example: similique

Channel Questions

Show all questions

Example request:

curl --request POST \
    "/api/v1/questions/read" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"xs090d8da....\",
    \"eventSlug\": \"streams\"
}"

const url = new URL(
    "/api/v1/questions/read"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "xs090d8da....",
    "eventSlug": "streams"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/questions/read',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'xs090d8da....',
            'eventSlug' => 'streams',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Create a question

Example request:

curl --request POST \
    "/api/v1/questions/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"question\": \"Do you have discounts?\",
    \"eventId\": \"ut\"
}"

const url = new URL(
    "/api/v1/questions/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "question": "Do you have discounts?",
    "eventId": "ut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/questions/create',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'question' => 'Do you have discounts?',
            'eventId' => 'ut',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Vote a question

Example request:

curl --request POST \
    "/api/v1/questions/vote" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"questionId\": \"Do you have discounts?\",
    \"direction\": 2
}"

const url = new URL(
    "/api/v1/questions/vote"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "questionId": "Do you have discounts?",
    "direction": 2
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/questions/vote',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'questionId' => 'Do you have discounts?',
            'direction' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Channel Streams

Update fields stream

Example request:

curl --request PUT \
    "/api/v1/streams/My6RVkeYP5lq1XAGoA7K3NovZ0L2EDma" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"autojoin\": true,
    \"is_live_manual\": true
}"

const url = new URL(
    "/api/v1/streams/My6RVkeYP5lq1XAGoA7K3NovZ0L2EDma"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "autojoin": true,
    "is_live_manual": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/streams/My6RVkeYP5lq1XAGoA7K3NovZ0L2EDma',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'autojoin' => true,
            'is_live_manual' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "is_live_manual": false,
        "is_live": false,
        "roomId": null,
        "autojoin": false,
        "channel": "pK5A4WvhCO",
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMWJ6MDFzdVFpN3IwMnc5dWMxdzQxVHpDZXVEcmppamNPWXQ1TVJsUHRLV1EiLCJhdWQiOiJ2IiwiZXhwIjoxNjgwODYyNDExLCJraWQiOiJwNDQ4UDAxQ3lwcDAwSUN3UDZ4Q1dUcGIzeUVrYzl4U2dvbGhXSVM1clJFSVEiLCJwbGF5YmFja19yZXN0cmljdGlvbl9pZCI6Imx6S2pDTjcwMHlkeU4wMWNsczc1S2lQMDBTNmRpc1E2c202dEJUSDN1QkZxcVEifQ.aQnDRMbOFxdLHcq8lEyj39et-lKntbaxHcdOciA7fS7Sk3C4dUjJGHB87jAHuUenOMujiDdWD5L4iNMpaMkeweD1qZNP-Rhsc4VDCtARA880n4gBej2V4gkOsYsO5Du1KHwNtLrLqp2uRvUDbSgX_o0qc15hk40TF-SGCJfhrWvtI4DAV5kxVyCVtgiH0asxlJIZkMJowQmip0TE4QzofShdJ0-9QVlz1iWW0VurCQLTtdGp2NmcEzXocCetHQBm7X7mwt8aJiUIUU_UuS8oD5csvOBBP4BnbovSg5x89l_c0kqHBwcZGzhMVzH2r8AAZ6ez41JtKIXpV4Wyr9m1FQ",
        "stream_key": "dacf1a91-a882-0a80-b138-636d40ff28e4",
        "playback": {
            "data": {
                "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                "playback_id": "31bz01suQi7r02w9uc1w41TzCeuDrjijcOYt5MRlPtKWQ"
            }
        },
        "space": null,
        "jwt": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Request

PUT api/v1/streams/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

Encoded stream id. Example: My6RVkeYP5lq1XAGoA7K3NovZ0L2EDma

Body Parameters

autojoin boolean true false

Auto join field for a channel when subscribers. Example: true

is_live_manual boolean true false

Trigger live status over the auto live status. Example: true

Channel Teams

Methods to manage events for token authenticated account.

Get team for an event

requires authentication

Example request:

curl --request GET \
    --get "/api/v1/events/jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7/team" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7/team"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7/team',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "event_access": [],
        "owner": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

GET api/v1/events/{id}/invitations

Example request:

curl --request GET \
    --get "/api/v1/events/officia/invitations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/officia/invitations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/officia/invitations',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

DELETE api/v1/events/{id}/invitations

Example request:

curl --request DELETE \
    "/api/v1/events/unde/invitations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/unde/invitations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/events/unde/invitations',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Add team for an event

requires authentication

Example request:

curl --request PUT \
    "/api/v1/events/voluptas/team" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"event_id\": \"jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7\",
    \"contributorId\": \"jvyVoRmJq...\"
}"

const url = new URL(
    "/api/v1/events/voluptas/team"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "event_id": "jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7",
    "contributorId": "jvyVoRmJq..."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/events/voluptas/team',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'event_id' => 'jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7',
            'contributorId' => 'jvyVoRmJq...',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "event_access": [],
        "owner": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Request

PUT api/v1/events/{id}/team

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

Example: voluptas

Body Parameters

event_id string optional

The id of the channel. Example: jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7

contributorId string optional

The id of the user. Example: jvyVoRmJq...

Remove team for an event

requires authentication

Example request:

curl --request DELETE \
    "/api/v1/events/explicabo/team" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"event_id\": \"jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7\",
    \"contributorId\": \"jvyVoRmJq...\"
}"

const url = new URL(
    "/api/v1/events/explicabo/team"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "event_id": "jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7",
    "contributorId": "jvyVoRmJq..."
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/events/explicabo/team',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'event_id' => 'jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7',
            'contributorId' => 'jvyVoRmJq...',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "event_access": [],
        "owner": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Request

DELETE api/v1/events/{id}/team

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

id string

Example: explicabo

Body Parameters

event_id string optional

The id of the channel. Example: jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7

contributorId string optional

The id of the user. Example: jvyVoRmJq...

Get team for an event

requires authentication

Example request:

curl --request GET \
    --get "/api/v1/api-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/api-token"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/api-token',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "event_access": [],
        "owner": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Add team for an event

requires authentication

Example request:

curl --request POST \
    "/api/v1/api-token/new" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"event_id\": \"jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7\",
    \"contributorId\": \"jvyVoRmJq...\"
}"

const url = new URL(
    "/api/v1/api-token/new"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "event_id": "jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7",
    "contributorId": "jvyVoRmJq..."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/api-token/new',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'event_id' => 'jvyVoRmJqWP53KApPAazpDZ4LQ6Yrng7',
            'contributorId' => 'jvyVoRmJq...',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "event_access": [],
        "owner": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Teams

GET api/v1/team

Example request:

curl --request GET \
    --get "/api/v1/team" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/team"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/team',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/team/members

Example request:

curl --request PUT \
    "/api/v1/team/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/team/members"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/team/members',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

DELETE api/v1/team/members

Example request:

curl --request DELETE \
    "/api/v1/team/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/team/members"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/team/members',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/team/members

Example request:

curl --request POST \
    "/api/v1/team/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 254706794.6,
    \"events\": [
        \"aykzbxymzhifwovkekquytlrzihjiaenoqbwfcpppavwsgrgxpsfariemd\"
    ]
}"

const url = new URL(
    "/api/v1/team/members"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 254706794.6,
    "events": [
        "aykzbxymzhifwovkekquytlrzihjiaenoqbwfcpppavwsgrgxpsfariemd"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/team/members',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'id' => 254706794.6,
            'events' => [
                'aykzbxymzhifwovkekquytlrzihjiaenoqbwfcpppavwsgrgxpsfariemd',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/team/belong

Example request:

curl --request GET \
    --get "/api/v1/team/belong" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/team/belong"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/team/belong',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

DELETE api/v1/team/{teamId}

Example request:

curl --request DELETE \
    "/api/v1/team/unde" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/team/unde"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/team/unde',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

User Profile

Get user details

Example request:

curl --request GET \
    --get "/api/v1/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/profile"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/profile',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Update user profile

Example request:

curl --request POST \
    "/api/v1/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"full_name\": \"dp\",
    \"username\": \"b\",
    \"description\": \"Vel enim quaerat deserunt eveniet fugit.\",
    \"location\": \"b\",
    \"currency_id\": 9366,
    \"phone\": \"qt\"
}"

const url = new URL(
    "/api/v1/profile"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "full_name": "dp",
    "username": "b",
    "description": "Vel enim quaerat deserunt eveniet fugit.",
    "location": "b",
    "currency_id": 9366,
    "phone": "qt"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'full_name' => 'dp',
            'username' => 'b',
            'description' => 'Vel enim quaerat deserunt eveniet fugit.',
            'location' => 'b',
            'currency_id' => 9366.0,
            'phone' => 'qt',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/profile

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

full_name string

Must be between 1 and 60 characters. Example: dp

username string optional

Must be between 1 and 49 characters. Example: b

description string optional

Must be between 1 and 500 characters. Example: Vel enim quaerat deserunt eveniet fugit.

location string optional

Must be between 1 and 100 characters. Example: b

currency_id number optional

Example: 9366

phone string optional

Must be between 1 and 50 characters. Example: qt

Follow channel streamer

Example request:

curl --request POST \
    "/api/v1/profile/follow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"channelId\": 8,
    \"following\": true
}"

const url = new URL(
    "/api/v1/profile/follow"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "channelId": 8,
    "following": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile/follow',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'channelId' => 8,
            'following' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get all currencies

Example request:

curl --request GET \
    --get "/api/v1/currencies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/currencies"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/currencies',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Verify an email using email and token from email. No authorization required

Example request:

curl --request POST \
    "/api/v1/auth/verify" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"hash\": null,
    \"email\": null
}"

const url = new URL(
    "/api/v1/auth/verify"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "hash": null,
    "email": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/verify',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'hash' => null,
            'email' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Change user password

requires authentication

Example request:

curl --request POST \
    "/api/v1/auth/password/change-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"32zyx!\",
    \"password\": \"xyz23!.\"
}"

const url = new URL(
    "/api/v1/auth/password/change-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "old_password": "32zyx!",
    "password": "xyz23!."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/password/change-password',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'old_password' => '32zyx!',
            'password' => 'xyz23!.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/profile/check-default-payment

Example request:

curl --request GET \
    --get "/api/v1/profile/check-default-payment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/profile/check-default-payment"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/profile/check-default-payment',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request an email verification email to be sent.

Example request:

curl --request GET \
    --get "/api/v1/profile/send-verification" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/profile/send-verification"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/profile/send-verification',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Channel Front Office

Get details of a channel

Example request:

curl --request GET \
    --get "/api/v1/events/playback/in" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"streams\",
    \"getQuestions\": true
}"

const url = new URL(
    "/api/v1/events/playback/in"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "streams",
    "getQuestions": true
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/playback/in',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'streams',
            'getQuestions' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "name": "Test 07042023",
        "slug": "pK5A4WvhCO",
        "chat_enabled": true,
        "guest_chat_enabled": true,
        "shop_enabled": true,
        "description": "This is a test channel for current sprint",
        "original_id": null,
        "banner_top": "https://cdn.streams.live/event/1/cover/b82a0af3a6c2ab3f46eb102ca442f79f.jpg",
        "free_pass": 2,
        "isOwner": false,
        "streamType": 2,
        "privacy": 2,
        "questions_enabled": false,
        "starts_at": null,
        "starts_at_notz": null,
        "starts_at_date": null,
        "starts_at_time": null,
        "starts_at_status": false,
        "timezone": "UTC",
        "show_online_users": true,
        "ecommerceProviderEnabled": false,
        "iCanSee": false,
        "theme": "default",
        "thread_id": 1,
        "user_notifications": false,
        "user_notifications_email": false,
        "user_notifications_sms": false,
        "user_add_to_calendar": false,
        "no_cookies_event": false,
        "hasOveitConnection": false,
        "paid": false,
        "withProducts": true,
        "owner": {
            "data": {
                "hash_id": "JnG2XDz46KOVl3dXJkA0ajRwLykvmoeW",
                "id": 55,
                "avatar": "https://cdn.streams.live/default-user-avatar.png",
                "subscriptionStatus": false,
                "first_name": "Oveit",
                "nickname": "Oveit Account",
                "currency": {
                    "data": {
                        "id": 1,
                        "name": "United States dollar",
                        "symbol": "$",
                        "iso_code": "USD"
                    }
                },
                "smartContract": {
                    "data": []
                }
            }
        },
        "stream": {
            "data": []
        },
        "media": {
            "data": []
        },
        "questionsCount": 0,
        "chatCount": 1,
        "following": {
            "data": []
        },
        "attributes": [],
        "playlist": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Request

GET api/v1/events/playback/{eventId}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: in

Body Parameters

eventId string

Channel slug. Example: streams

getQuestions boolean optional true false

Get channel details with questions. Example: true

Get details of a channel

Example request:

curl --request POST \
    "/api/v1/events/playback/dolores" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"streams\",
    \"getQuestions\": true
}"

const url = new URL(
    "/api/v1/events/playback/dolores"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "streams",
    "getQuestions": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/playback/dolores',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'streams',
            'getQuestions' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "name": "Test 07042023",
        "slug": "pK5A4WvhCO",
        "chat_enabled": true,
        "guest_chat_enabled": true,
        "shop_enabled": true,
        "description": "This is a test channel for current sprint",
        "original_id": null,
        "banner_top": "https://cdn.streams.live/event/1/cover/b82a0af3a6c2ab3f46eb102ca442f79f.jpg",
        "free_pass": 2,
        "isOwner": false,
        "streamType": 2,
        "privacy": 2,
        "questions_enabled": false,
        "starts_at": null,
        "starts_at_notz": null,
        "starts_at_date": null,
        "starts_at_time": null,
        "starts_at_status": false,
        "timezone": "UTC",
        "show_online_users": true,
        "ecommerceProviderEnabled": false,
        "iCanSee": false,
        "theme": "default",
        "thread_id": 1,
        "user_notifications": false,
        "user_notifications_email": false,
        "user_notifications_sms": false,
        "user_add_to_calendar": false,
        "no_cookies_event": false,
        "hasOveitConnection": false,
        "paid": false,
        "withProducts": true,
        "owner": {
            "data": {
                "hash_id": "JnG2XDz46KOVl3dXJkA0ajRwLykvmoeW",
                "id": 55,
                "avatar": "https://cdn.streams.live/default-user-avatar.png",
                "subscriptionStatus": false,
                "first_name": "Oveit",
                "nickname": "Oveit Account",
                "currency": {
                    "data": {
                        "id": 1,
                        "name": "United States dollar",
                        "symbol": "$",
                        "iso_code": "USD"
                    }
                },
                "smartContract": {
                    "data": []
                }
            }
        },
        "stream": {
            "data": []
        },
        "media": {
            "data": []
        },
        "questionsCount": 0,
        "chatCount": 1,
        "following": {
            "data": []
        },
        "attributes": [],
        "playlist": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events/playback/{eventId}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: dolores

Body Parameters

eventId string

Channel slug. Example: streams

getQuestions boolean optional true false

Get channel details with questions. Example: true

Get products of a channel

Example request:

curl --request GET \
    --get "/api/v1/events/products/eum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"streams\"
}"

const url = new URL(
    "/api/v1/events/products/eum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "streams"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/products/eum',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'streams',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "name": "Test 07042023",
        "slug": "pK5A4WvhCO",
        "chat_enabled": true,
        "guest_chat_enabled": true,
        "shop_enabled": true,
        "description": "This is a test channel for current sprint",
        "location": null,
        "tickets": 0,
        "tickets_sold": 0,
        "tickets_checked_in": 0,
        "original_id": null,
        "background_url": null,
        "banner_top": "https://cdn.streams.live/event/1/cover/b82a0af3a6c2ab3f46eb102ca442f79f.jpg",
        "disk_quota": 0,
        "free_pass": 2,
        "isOwner": false,
        "isShared": false,
        "canAddMoreProducts": true,
        "streamType": 2,
        "privacy": 2,
        "questions_enabled": false,
        "starts_at": null,
        "starts_at_notz": null,
        "starts_at_date": null,
        "starts_at_time": null,
        "starts_at_status": false,
        "user_notifications": false,
        "notifications_msg": "",
        "timezone": "UTC",
        "theme": "default",
        "show_online_users": true,
        "ecommerceProviderEnabled": null,
        "nftsEnabled": false,
        "thread_id": 1,
        "last_update": "2023-04-07T10:12:36.000000Z",
        "isInstagramMultiCastAvailable": true,
        "paid": false,
        "withProducts": true,
        "owner": {
            "data": {
                "hash_id": "JnG2XDz46KOVl3dXJkA0ajRwLykvmoeW",
                "id": 55,
                "username": "",
                "nickname": "Oveit Account",
                "subscription": false,
                "subscriptionStatus": false,
                "isVerified": true,
                "avatar": "https://cdn.streams.live/default-user-avatar.png",
                "currency": {
                    "data": {
                        "id": 1,
                        "name": "United States dollar",
                        "symbol": "$",
                        "iso_code": "USD"
                    }
                }
            }
        },
        "stream": {
            "data": {
                "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                "is_live_manual": false,
                "is_live": false,
                "roomId": null,
                "autojoin": false,
                "channel": "pK5A4WvhCO",
                "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJGRkRPVWdEODZMeEFCbGdNSEZkbjQ1cWllQWZjYzkzdHgydElaTkVoVTJ3IiwiYXVkIjoidiIsImV4cCI6MTY4MDg2OTI4OCwia2lkIjoicDQ0OFAwMUN5cHAwMElDd1A2eENXVHBiM3lFa2M5eFNnb2xoV0lTNXJSRUlRIiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiJsektqQ043MDB5ZHlOMDFjbHM3NUtpUDAwUzZkaXNRNnNtNnRCVEgzdUJGcXFRIn0.olGw3MOcITWvTyGnrBHbHn8XSaP7KgbuzlnKV_WW8pyyyvhdz1_tHcDeNqBff1liJZj4a2Iy8kkHRkzTt6YpLUd2jBLsZo1LP8bqCZt-vPAC19RnMUPZxyCYG7B--8t8eNyVudNndzZwfQzBKb2LJ1LsaVx0semD5m5swLtvPJS9iOEEohpLyESRUKGmNEhokVOj6GJ_Eut7W63gXrbDzBZ7Jutmg_aQkKSddbsn5iG38tqtf_yhHxPRZku8gMCp8sfAs0qyqWypliXmqW2kBkfraj03QyugKXqImcspE2MJTuQvHsjmSIixGTmskpfNK60hab_3lOJ6xXTZIILFjA",
                "stream_key": "ffe8860b-1d46-3c7b-204f-9bc0ca12caec",
                "playback": {
                    "data": {
                        "id": "VQYK62LW3o8aGv9L6bJnxBRelzkjg0qp",
                        "playback_id": "FFDOUgD86LxABlgMHFdn45qieAfcc93tx2tIZNEhU2w"
                    }
                },
                "space": null,
                "jwt": {
                    "data": []
                }
            }
        },
        "media": {
            "data": []
        },
        "products": {
            "data": [
                {
                    "id": 4,
                    "name": "Test",
                    "link": "https://google.com",
                    "price": 2,
                    "fixed_price": true,
                    "currency": "USD",
                    "reference": null,
                    "bumped": false,
                    "for_sale": false,
                    "hasOnlyDefaultVariant": false,
                    "isQuantityBased": false,
                    "imageSource": null,
                    "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
                    "app": null,
                    "variants": {
                        "data": []
                    },
                    "quantity": {
                        "total": null,
                        "sold": 0,
                        "available": 0,
                        "no_limit": true
                    }
                }
            ]
        },
        "questionsCount": 0,
        "chatCount": 1,
        "following": {
            "data": []
        },
        "attributes": [],
        "features": {
            "data": [
                {
                    "name": "30 Streaming Minutes",
                    "identifier": "streaming_minutes",
                    "value": 30
                },
                {
                    "name": "Live show",
                    "identifier": "liveShow",
                    "value": null
                },
                {
                    "name": "Live party",
                    "identifier": "liveParty",
                    "value": null
                },
                {
                    "name": "Chat",
                    "identifier": "chat",
                    "value": null
                },
                {
                    "name": "Live shopping products",
                    "identifier": "products",
                    "value": 5
                },
                {
                    "name": "1 Live channels",
                    "identifier": "channelsLimit",
                    "value": 1
                },
                {
                    "name": "Analytics",
                    "identifier": "analytics",
                    "value": null
                },
                {
                    "name": "Invite 1 account team members",
                    "identifier": "teamMembers",
                    "value": 1
                },
                {
                    "name": "Dedicated channel page on streams.live",
                    "identifier": "channel",
                    "value": null
                },
                {
                    "name": "Media files stored for 1 month(s)",
                    "identifier": "mediaValidity",
                    "value": 1
                }
            ]
        },
        "minutes": 30,
        "simulcasts": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Subscribe to a channel

Example request:

curl --request POST \
    "/api/v1/events/notification" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"streams\",
    \"phone\": \"074422...\",
    \"phonePrefix\": \"+1\",
    \"email\": \"streams@streams.live\"
}"

const url = new URL(
    "/api/v1/events/notification"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "streams",
    "phone": "074422...",
    "phonePrefix": "+1",
    "email": "streams@streams.live"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/notification',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'streams',
            'phone' => '074422...',
            'phonePrefix' => '+1',
            'email' => 'streams@streams.live',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


null

Example response (402):


null

Received response:

Request failed with error:

Request

POST api/v1/events/notification

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

eventId string

Channel slug. Example: streams

phone string

Phone of subscriber (only required when no email attribute). Example: 074422...

phonePrefix string

Phone prefix of subscriber (only required when phone attribute is present). Example: +1

email string

Email of subscriber (only required when no phone attribute). Example: streams@streams.live

Get some stats

Example request:

curl --request POST \
    "/api/v1/events/stats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"quod\"
}"

const url = new URL(
    "/api/v1/events/stats"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "quod"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/stats',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'quod',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Start a view

Example request:

curl --request POST \
    "/api/v1/events/heartbeat" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"quam\",
    \"viewerHash\": \"dignissimos\",
    \"viewHash\": \"accusantium\",
    \"date\": \"voluptas\"
}"

const url = new URL(
    "/api/v1/events/heartbeat"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "quam",
    "viewerHash": "dignissimos",
    "viewHash": "accusantium",
    "date": "voluptas"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/heartbeat',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'quam',
            'viewerHash' => 'dignissimos',
            'viewHash' => 'accusantium',
            'date' => 'voluptas',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events/heartbeat

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

eventId string

Example: quam

viewerHash string

Example: dignissimos

viewHash string

Example: accusantium

date string

Example: voluptas

Add a message

requires authentication

Example request:

curl --request POST \
    "/api/v1/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": \"szjzna\",
    \"thread_id\": 2621.068,
    \"reply_for\": \"tenetur\",
    \"locale\": \"as_IN\"
}"

const url = new URL(
    "/api/v1/messages"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "data": "szjzna",
    "thread_id": 2621.068,
    "reply_for": "tenetur",
    "locale": "as_IN"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/messages',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'data' => 'szjzna',
            'thread_id' => 2621.068,
            'reply_for' => 'tenetur',
            'locale' => 'as_IN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/messages

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

data string

Must not be greater than 300 characters. Example: szjzna

thread_id number

Example: 2621.068

reply_for string optional

Example: tenetur

locale string optional

Example: as_IN

Add a message as guest

Example request:

curl --request POST \
    "/api/v1/messages/guest" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": \"owebkqmgmnqurdjg\",
    \"thread_id\": 1.09,
    \"reply_for\": \"occaecati\",
    \"locale\": \"ar_MA\"
}"

const url = new URL(
    "/api/v1/messages/guest"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "data": "owebkqmgmnqurdjg",
    "thread_id": 1.09,
    "reply_for": "occaecati",
    "locale": "ar_MA"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/messages/guest',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'data' => 'owebkqmgmnqurdjg',
            'thread_id' => 1.09,
            'reply_for' => 'occaecati',
            'locale' => 'ar_MA',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/messages/guest

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

data string

Must not be greater than 300 characters. Example: owebkqmgmnqurdjg

thread_id number

Example: 1.09

reply_for string optional

Example: occaecati

locale string optional

Example: ar_MA

Load and read channel conversation

requires authentication

Example request:

curl --request POST \
    "/api/v1/thread/read" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"threadSlug\": \"fedot\",
    \"userId\": \"54\"
}"

const url = new URL(
    "/api/v1/thread/read"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "threadSlug": "fedot",
    "userId": "54"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/thread/read',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'threadSlug' => 'fedot',
            'userId' => '54',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Add guest participant to thread

requires authentication

Example request:

curl --request POST \
    "/api/v1/thread/participant" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/thread/participant"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/thread/participant',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Channel Multicast

Create simulcast target

Example request:

curl --request POST \
    "/api/v1/events/consequuntur/simulcast" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"voluptas\",
    \"url\": \"facilis\",
    \"key\": \"delectus\"
}"

const url = new URL(
    "/api/v1/events/consequuntur/simulcast"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "voluptas",
    "url": "facilis",
    "key": "delectus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/consequuntur/simulcast',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'voluptas',
            'url' => 'facilis',
            'key' => 'delectus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "url": null,
        "name": null,
        "status": null,
        "key": null
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events/{eventId}/simulcast

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: consequuntur

id string

Add simulcast for event id. Example: 2

Body Parameters

name string

Example: voluptas

url string

Example: facilis

key string

Example: delectus

Toggle simulcast target

Example request:

curl --request POST \
    "/api/v1/events/et/simulcast/toggle" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": false
}"

const url = new URL(
    "/api/v1/events/et/simulcast/toggle"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/et/simulcast/toggle',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'status' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "url": null,
        "name": null,
        "status": null,
        "key": null
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events/{eventId}/simulcast/toggle

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: et

id string

Change status for a stream id. Example: 2

Body Parameters

status boolean true false

Change status for a stream id. Example: false

Delete simulcast target

Example request:

curl --request DELETE \
    "/api/v1/events/consequatur/simulcast/quia" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/consequatur/simulcast/quia"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/events/consequatur/simulcast/quia',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


null

Received response:

Request failed with error:

Request

DELETE api/v1/events/{eventId}/simulcast/{targetId}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: consequatur

targetId string

Example: quia

id string

Change status for a stream id. Example: 2

Channel Stats

Get stats using interval

Example request:

curl --request POST \
    "/api/v1/stats/parse/interval" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"vrmcdbbuvlgdcxybyobfzakbvvhhmo\",
    \"interval\": 1.903,
    \"range\": [
        \"2023-04-10T09:59:48\",
        \"2023-04-10T09:59:48\"
    ],
    \"section\": 0
}"

const url = new URL(
    "/api/v1/stats/parse/interval"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "vrmcdbbuvlgdcxybyobfzakbvvhhmo",
    "interval": 1.903,
    "range": [
        "2023-04-10T09:59:48",
        "2023-04-10T09:59:48"
    ],
    "section": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stats/parse/interval',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'vrmcdbbuvlgdcxybyobfzakbvvhhmo',
            'interval' => 1.903,
            'range' => [
                '2023-04-10T09:59:48',
                '2023-04-10T09:59:48',
            ],
            'section' => 0.0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/stats/parse/interval

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

eventId string

Must be at least 3 characters. Example: vrmcdbbuvlgdcxybyobfzakbvvhhmo

interval number optional

Example: 1.903

range object optional

0 string

Must be a valid date. Example: 2023-04-10T09:59:48

1 string

Must be a valid date. Example: 2023-04-10T09:59:48

section number

Example: 0

List sessions

Example request:

curl --request GET \
    --get "/api/v1/stats/sessions/iste" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stats/sessions/iste"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/stats/sessions/iste',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get stats of a session

Example request:

curl --request GET \
    --get "/api/v1/stats/session/nemo" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stats/session/nemo"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/stats/session/nemo',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Event Multicast

Update multicast target

Example request:

curl --request POST \
    "/api/v1/events/sint/simulcast/est" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"praesentium\",
    \"url\": \"itaque\",
    \"key\": \"dolorem\"
}"

const url = new URL(
    "/api/v1/events/sint/simulcast/est"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "praesentium",
    "url": "itaque",
    "key": "dolorem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/sint/simulcast/est',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'praesentium',
            'url' => 'itaque',
            'key' => 'dolorem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events/{eventId}/simulcast/{targetId}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: sint

targetId string

Example: est

Body Parameters

name string

Example: praesentium

url string

Example: itaque

key string

Example: dolorem

Others

Methods to manage events for token authenticated account.

GET /

Example request:

curl --request GET \
    --get "/" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1

Example request:

curl --request GET \
    --get "/api/v1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/stress

Example request:

curl --request GET \
    --get "/api/v1/stress" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stress"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/stress',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/stress-cached

Example request:

curl --request GET \
    --get "/api/v1/stress-cached" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stress-cached"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/stress-cached',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/log

Example request:

curl --request POST \
    "/api/v1/log" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/log"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/log',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/auth/register

Example request:

curl --request PUT \
    "/api/v1/auth/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"jgrimes@example.com\"
}"

const url = new URL(
    "/api/v1/auth/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "jgrimes@example.com"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/auth/register',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'jgrimes@example.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/auth/revoke

Example request:

curl --request POST \
    "/api/v1/auth/revoke" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/auth/revoke"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/auth/revoke',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/media-to-delete/{page}

Example request:

curl --request GET \
    --get "/api/v1/media-to-delete/autem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/media-to-delete/autem"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/media-to-delete/autem',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/test

Example request:

curl --request GET \
    --get "/api/v1/test" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/test"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/test',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get team for an event

requires authentication

Example request:

curl --request GET \
    --get "/api/v1/statistics" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/statistics"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/statistics',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "event_access": [],
        "owner": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Get team for an event

requires authentication

Example request:

curl --request POST \
    "/api/v1/statistics/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/statistics/user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/statistics/user',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "",
        "event_access": [],
        "owner": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

POST api/v1/deploy-callback

Example request:

curl --request POST \
    "/api/v1/deploy-callback" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/deploy-callback"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/deploy-callback',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/jwt

Example request:

curl --request GET \
    --get "/api/v1/jwt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/jwt"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/jwt',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/messages/store-messages

Example request:

curl --request POST \
    "/api/v1/messages/store-messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/messages/store-messages"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/messages/store-messages',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/order

Example request:

curl --request POST \
    "/api/v1/apps/order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/order',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/woo-auth

Example request:

curl --request POST \
    "/api/v1/apps/woo-auth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key_id\": 3.976,
    \"user_id\": \"impedit\",
    \"consumer_key\": \"nihil\",
    \"consumer_secret\": \"nihil\"
}"

const url = new URL(
    "/api/v1/apps/woo-auth"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "key_id": 3.976,
    "user_id": "impedit",
    "consumer_key": "nihil",
    "consumer_secret": "nihil"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/woo-auth',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'key_id' => 3.976,
            'user_id' => 'impedit',
            'consumer_key' => 'nihil',
            'consumer_secret' => 'nihil',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/apps/woo-auth

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

key_id number

Example: 3.976

user_id string

Example: impedit

consumer_key string

Example: nihil

consumer_secret string

Example: nihil

Get all events through client_credentials token.

Example request:

curl --request GET \
    --get "/api/v1/apps/app-get-channels" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/app-get-channels"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/apps/app-get-channels',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get event through client_credentials token.

Example request:

curl --request GET \
    --get "/api/v1/apps/app-get-channels-status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/app-get-channels-status"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/apps/app-get-channels-status',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get event through client_credentials token.

Example request:

curl --request GET \
    --get "/api/v1/apps/app-get-channel/incidunt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/app-get-channel/incidunt"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/apps/app-get-channel/incidunt',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/data

Example request:

curl --request POST \
    "/api/v1/apps/shopify/data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/data"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/data',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/customer

Example request:

curl --request POST \
    "/api/v1/apps/shopify/customer" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/customer"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/customer',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/shop

Example request:

curl --request POST \
    "/api/v1/apps/shopify/shop" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/shop"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/shop',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/check

Example request:

curl --request POST \
    "/api/v1/apps/shopify/check" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/check"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/check',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/oauth

Example request:

curl --request POST \
    "/api/v1/apps/shopify/oauth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"aut\",
    \"hmac\": \"perspiciatis\",
    \"shop\": \"rerum\",
    \"timestamp\": 12304683.7743
}"

const url = new URL(
    "/api/v1/apps/shopify/oauth"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "aut",
    "hmac": "perspiciatis",
    "shop": "rerum",
    "timestamp": 12304683.7743
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/oauth',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'code' => 'aut',
            'hmac' => 'perspiciatis',
            'shop' => 'rerum',
            'timestamp' => 12304683.7743,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/apps/shopify/oauth

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

code string

Example: aut

hmac string

Example: perspiciatis

shop string

Example: rerum

timestamp number

Example: 12304683.7743

GET api/v1/products/{productId}/available

Example request:

curl --request GET \
    --get "/api/v1/products/error/available" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/products/error/available"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/products/error/available',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/products/transaction

Example request:

curl --request PUT \
    "/api/v1/products/transaction" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"productId\": 430233454.6467119,
    \"json\": \"[\\\"cum\\\",\\\"deleniti\\\"]\"
}"

const url = new URL(
    "/api/v1/products/transaction"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "productId": 430233454.6467119,
    "json": "[\"cum\",\"deleniti\"]"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/products/transaction',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'productId' => 430233454.6467119,
            'json' => '["cum","deleniti"]',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/products/{productId}/json

Example request:

curl --request GET \
    --get "/api/v1/products/similique/json" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/products/similique/json"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/products/similique/json',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/stage/{eventSlug}

Example request:

curl --request GET \
    --get "/api/v1/stage/id" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stage/id"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/stage/id',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/events/event/{eventId}/cart

Example request:

curl --request POST \
    "/api/v1/events/event/sed/cart" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/event/sed/cart"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/event/sed/cart',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/events/event/{eventId}/cart/{type}/{cartId}

Example request:

curl --request PUT \
    "/api/v1/events/event/qui/cart/excepturi/illum" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/event/qui/cart/excepturi/illum"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/events/event/qui/cart/excepturi/illum',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

PUT api/v1/events/event/{eventId}/cart/{type}/{cartId}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: qui

type string

Example: excepturi

cartId string

Example: illum

PATCH api/v1/events/event/{eventId}/cart/{cartId}/{cartItemId}

Example request:

curl --request PATCH \
    "/api/v1/events/event/excepturi/cart/possimus/qui" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/event/excepturi/cart/possimus/qui"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    '/api/v1/events/event/excepturi/cart/possimus/qui',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

PATCH api/v1/events/event/{eventId}/cart/{cartId}/{cartItemId}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: excepturi

cartId string

Example: possimus

cartItemId string

Example: qui

DELETE api/v1/events/event/{eventId}/cart/{cartId}/{cartItemId}

Example request:

curl --request DELETE \
    "/api/v1/events/event/labore/cart/inventore/deserunt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/event/labore/cart/inventore/deserunt"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/events/event/labore/cart/inventore/deserunt',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

DELETE api/v1/events/event/{eventId}/cart/{cartId}/{cartItemId}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

eventId string

Example: labore

cartId string

Example: inventore

cartItemId string

Example: deserunt

Get supported languages

requires authentication

Example request:

curl --request GET \
    --get "/api/v1/localizations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/localizations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/localizations',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "localizations": [
        {
            "id": "ar",
            "language": {
                "code": "ar",
                "default_name": "Arabic",
                "locale_name": "العربية"
            },
            "regions": []
        },
        {
            "id": "en",
            "language": {
                "code": "en",
                "default_name": "English",
                "locale_name": "English"
            },
            "regions": [
                {
                    "code": "en-GB",
                    "default_name": "United Kingdom",
                    "locale_name": "United Kingdom"
                },
                {
                    "code": "en-US",
                    "default_name": "United States",
                    "locale_name": "United States"
                }
            ]
        },
        {
            "id": "zh",
            "language": {
                "code": "zh",
                "default_name": "Chinese",
                "locale_name": "中文"
            },
            "regions": [
                {
                    "code": "zh-CN",
                    "default_name": "China",
                    "locale_name": "中国"
                }
            ]
        },
        {
            "id": "es",
            "language": {
                "code": "es",
                "default_name": "Spanish",
                "locale_name": "español"
            },
            "regions": []
        },
        {
            "id": "fr",
            "language": {
                "code": "fr",
                "default_name": "French",
                "locale_name": "français"
            },
            "regions": []
        }
    ]
}

Received response:

Request failed with error:

Get all streams of a user

Example request:

curl --request GET \
    --get "/api/v1/streams" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/streams"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/streams',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": [
        {
            "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "is_live_manual": false,
            "is_live": false,
            "roomId": null,
            "autojoin": false,
            "channel": "pK5A4WvhCO",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMWJ6MDFzdVFpN3IwMnc5dWMxdzQxVHpDZXVEcmppamNPWXQ1TVJsUHRLV1EiLCJhdWQiOiJ2IiwiZXhwIjoxNjgwODYyNDExLCJraWQiOiJwNDQ4UDAxQ3lwcDAwSUN3UDZ4Q1dUcGIzeUVrYzl4U2dvbGhXSVM1clJFSVEiLCJwbGF5YmFja19yZXN0cmljdGlvbl9pZCI6Imx6S2pDTjcwMHlkeU4wMWNsczc1S2lQMDBTNmRpc1E2c202dEJUSDN1QkZxcVEifQ.aQnDRMbOFxdLHcq8lEyj39et-lKntbaxHcdOciA7fS7Sk3C4dUjJGHB87jAHuUenOMujiDdWD5L4iNMpaMkeweD1qZNP-Rhsc4VDCtARA880n4gBej2V4gkOsYsO5Du1KHwNtLrLqp2uRvUDbSgX_o0qc15hk40TF-SGCJfhrWvtI4DAV5kxVyCVtgiH0asxlJIZkMJowQmip0TE4QzofShdJ0-9QVlz1iWW0VurCQLTtdGp2NmcEzXocCetHQBm7X7mwt8aJiUIUU_UuS8oD5csvOBBP4BnbovSg5x89l_c0kqHBwcZGzhMVzH2r8AAZ6ez41JtKIXpV4Wyr9m1FQ",
            "stream_key": "dacf1a91-a882-0a80-b138-636d40ff28e4",
            "playback": {
                "data": {
                    "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                    "playback_id": "31bz01suQi7r02w9uc1w41TzCeuDrjijcOYt5MRlPtKWQ"
                }
            },
            "space": null,
            "jwt": {
                "data": []
            }
        },
        {
            "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "is_live_manual": false,
            "is_live": false,
            "roomId": null,
            "autojoin": false,
            "channel": "pK5A4WvhCO",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMWJ6MDFzdVFpN3IwMnc5dWMxdzQxVHpDZXVEcmppamNPWXQ1TVJsUHRLV1EiLCJhdWQiOiJ2IiwiZXhwIjoxNjgwODYyNDExLCJraWQiOiJwNDQ4UDAxQ3lwcDAwSUN3UDZ4Q1dUcGIzeUVrYzl4U2dvbGhXSVM1clJFSVEiLCJwbGF5YmFja19yZXN0cmljdGlvbl9pZCI6Imx6S2pDTjcwMHlkeU4wMWNsczc1S2lQMDBTNmRpc1E2c202dEJUSDN1QkZxcVEifQ.aQnDRMbOFxdLHcq8lEyj39et-lKntbaxHcdOciA7fS7Sk3C4dUjJGHB87jAHuUenOMujiDdWD5L4iNMpaMkeweD1qZNP-Rhsc4VDCtARA880n4gBej2V4gkOsYsO5Du1KHwNtLrLqp2uRvUDbSgX_o0qc15hk40TF-SGCJfhrWvtI4DAV5kxVyCVtgiH0asxlJIZkMJowQmip0TE4QzofShdJ0-9QVlz1iWW0VurCQLTtdGp2NmcEzXocCetHQBm7X7mwt8aJiUIUU_UuS8oD5csvOBBP4BnbovSg5x89l_c0kqHBwcZGzhMVzH2r8AAZ6ez41JtKIXpV4Wyr9m1FQ",
            "stream_key": "dacf1a91-a882-0a80-b138-636d40ff28e4",
            "playback": {
                "data": {
                    "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                    "playback_id": "31bz01suQi7r02w9uc1w41TzCeuDrjijcOYt5MRlPtKWQ"
                }
            },
            "space": null,
            "jwt": {
                "data": []
            }
        }
    ]
}

Received response:

Request failed with error:

Get a stream by stream id

Example request:

curl --request GET \
    --get "/api/v1/streams/34" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/streams/34"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/streams/34',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": [
        {
            "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "is_live_manual": false,
            "is_live": false,
            "roomId": null,
            "autojoin": false,
            "channel": "pK5A4WvhCO",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMWJ6MDFzdVFpN3IwMnc5dWMxdzQxVHpDZXVEcmppamNPWXQ1TVJsUHRLV1EiLCJhdWQiOiJ2IiwiZXhwIjoxNjgwODYyNDExLCJraWQiOiJwNDQ4UDAxQ3lwcDAwSUN3UDZ4Q1dUcGIzeUVrYzl4U2dvbGhXSVM1clJFSVEiLCJwbGF5YmFja19yZXN0cmljdGlvbl9pZCI6Imx6S2pDTjcwMHlkeU4wMWNsczc1S2lQMDBTNmRpc1E2c202dEJUSDN1QkZxcVEifQ.aQnDRMbOFxdLHcq8lEyj39et-lKntbaxHcdOciA7fS7Sk3C4dUjJGHB87jAHuUenOMujiDdWD5L4iNMpaMkeweD1qZNP-Rhsc4VDCtARA880n4gBej2V4gkOsYsO5Du1KHwNtLrLqp2uRvUDbSgX_o0qc15hk40TF-SGCJfhrWvtI4DAV5kxVyCVtgiH0asxlJIZkMJowQmip0TE4QzofShdJ0-9QVlz1iWW0VurCQLTtdGp2NmcEzXocCetHQBm7X7mwt8aJiUIUU_UuS8oD5csvOBBP4BnbovSg5x89l_c0kqHBwcZGzhMVzH2r8AAZ6ez41JtKIXpV4Wyr9m1FQ",
            "stream_key": "dacf1a91-a882-0a80-b138-636d40ff28e4",
            "playback": {
                "data": {
                    "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                    "playback_id": "31bz01suQi7r02w9uc1w41TzCeuDrjijcOYt5MRlPtKWQ"
                }
            },
            "space": null,
            "jwt": {
                "data": []
            }
        },
        {
            "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
            "is_live_manual": false,
            "is_live": false,
            "roomId": null,
            "autojoin": false,
            "channel": "pK5A4WvhCO",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMWJ6MDFzdVFpN3IwMnc5dWMxdzQxVHpDZXVEcmppamNPWXQ1TVJsUHRLV1EiLCJhdWQiOiJ2IiwiZXhwIjoxNjgwODYyNDExLCJraWQiOiJwNDQ4UDAxQ3lwcDAwSUN3UDZ4Q1dUcGIzeUVrYzl4U2dvbGhXSVM1clJFSVEiLCJwbGF5YmFja19yZXN0cmljdGlvbl9pZCI6Imx6S2pDTjcwMHlkeU4wMWNsczc1S2lQMDBTNmRpc1E2c202dEJUSDN1QkZxcVEifQ.aQnDRMbOFxdLHcq8lEyj39et-lKntbaxHcdOciA7fS7Sk3C4dUjJGHB87jAHuUenOMujiDdWD5L4iNMpaMkeweD1qZNP-Rhsc4VDCtARA880n4gBej2V4gkOsYsO5Du1KHwNtLrLqp2uRvUDbSgX_o0qc15hk40TF-SGCJfhrWvtI4DAV5kxVyCVtgiH0asxlJIZkMJowQmip0TE4QzofShdJ0-9QVlz1iWW0VurCQLTtdGp2NmcEzXocCetHQBm7X7mwt8aJiUIUU_UuS8oD5csvOBBP4BnbovSg5x89l_c0kqHBwcZGzhMVzH2r8AAZ6ez41JtKIXpV4Wyr9m1FQ",
            "stream_key": "dacf1a91-a882-0a80-b138-636d40ff28e4",
            "playback": {
                "data": {
                    "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                    "playback_id": "31bz01suQi7r02w9uc1w41TzCeuDrjijcOYt5MRlPtKWQ"
                }
            },
            "space": null,
            "jwt": {
                "data": []
            }
        }
    ]
}

Received response:

Request failed with error:

Delete stream

Example request:

curl --request DELETE \
    "/api/v1/streams/My6RVkeYP5lq1XAGoA7K3NovZ0L2EDma" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/streams/My6RVkeYP5lq1XAGoA7K3NovZ0L2EDma"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/streams/My6RVkeYP5lq1XAGoA7K3NovZ0L2EDma',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


null

Received response:

Request failed with error:

GET api/v1/events/{id}/nfts

Example request:

curl --request GET \
    --get "/api/v1/events/totam/nfts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/totam/nfts"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/totam/nfts',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/events/{id}/nfts/enable

Example request:

curl --request PUT \
    "/api/v1/events/voluptas/nfts/enable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"nft_id\": 196975311.12
}"

const url = new URL(
    "/api/v1/events/voluptas/nfts/enable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "nft_id": 196975311.12
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/events/voluptas/nfts/enable',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'nft_id' => 196975311.12,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Generate event invite code

Example request:

curl --request POST \
    "/api/v1/events/d09djkd9dw2232e2.../generate-code" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/d09djkd9dw2232e2.../generate-code"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/d09djkd9dw2232e2.../generate-code',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
id: d09djkd9dw2232e2...,
code: 200
}

Received response:

Request failed with error:

Add product to the channel

Example request:

curl --request POST \
    "/api/v1/events/345/products/add" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=Nike Shoes" \
    --form "link=http://shop.test/product-nike-shoes" \
    --form "price=23.6" \
    --form "image=@/tmp/phpBcepBk"

const url = new URL(
    "/api/v1/events/345/products/add"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'Nike Shoes');
body.append('link', 'http://shop.test/product-nike-shoes');
body.append('price', '23.6');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/345/products/add',
    [
        'headers' => [
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'Nike Shoes'
            ],
            [
                'name' => 'link',
                'contents' => 'http://shop.test/product-nike-shoes'
            ],
            [
                'name' => 'price',
                'contents' => '23.6'
            ],
            [
                'name' => 'image',
                'contents' => fopen('/tmp/phpBcepBk', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": 4,
        "name": "Test",
        "link": "https://google.com",
        "price": 2,
        "fixed_price": true,
        "currency": "USD",
        "reference": null,
        "bumped": false,
        "for_sale": false,
        "hasOnlyDefaultVariant": false,
        "isQuantityBased": false,
        "imageSource": null,
        "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
        "app": null,
        "variants": {
            "data": []
        },
        "quantity": {
            "total": null,
            "sold": 0,
            "available": 0,
            "no_limit": true
        }
    }
}

Received response:

Request failed with error:

Request

POST api/v1/events/{id}/products/add

Headers

Content-Type

Example: multipart/form-data

Accept

Example: application/json

URL Parameters

id string

The ID of the event. Example: 345

Body Parameters

name string

The name of the product. Example: Nike Shoes

link url

The link of the product. Example: http://shop.test/product-nike-shoes

price numeric

The price of the product. Example: 23.6

image file

The main image of the product (jpeg/jpg, png). Example: /tmp/phpBcepBk

POST api/v1/profile/can

Example request:

curl --request POST \
    "/api/v1/profile/can" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"can\": \"add_channels\"
}"

const url = new URL(
    "/api/v1/profile/can"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "can": "add_channels"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile/can',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'can' => 'add_channels',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/profile/smart-contracts

Example request:

curl --request GET \
    --get "/api/v1/profile/smart-contracts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/profile/smart-contracts"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/profile/smart-contracts',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/profile/smart-contracts/deploy

Example request:

curl --request POST \
    "/api/v1/profile/smart-contracts/deploy" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contractType\": 152.5086751
}"

const url = new URL(
    "/api/v1/profile/smart-contracts/deploy"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "contractType": 152.5086751
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile/smart-contracts/deploy',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'contractType' => 152.5086751,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

DELETE api/v1/profile/smart-contracts

Example request:

curl --request DELETE \
    "/api/v1/profile/smart-contracts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/profile/smart-contracts"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/profile/smart-contracts',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get stats for a session

Example request:

curl --request POST \
    "/api/v1/stats/parse" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"repellat\",
    \"section\": 610504.1905
}"

const url = new URL(
    "/api/v1/stats/parse"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "repellat",
    "section": 610504.1905
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stats/parse',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'repellat',
            'section' => 610504.1905,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/stats/parse/download

Example request:

curl --request POST \
    "/api/v1/stats/parse/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stats/parse/download"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stats/parse/download',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/stats/parse/download/subscribers

Example request:

curl --request POST \
    "/api/v1/stats/parse/download/subscribers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stats/parse/download/subscribers"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stats/parse/download/subscribers',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/stats/parse/download/chat

Example request:

curl --request POST \
    "/api/v1/stats/parse/download/chat" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stats/parse/download/chat"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stats/parse/download/chat',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/stats/parse/download/questions

Example request:

curl --request POST \
    "/api/v1/stats/parse/download/questions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stats/parse/download/questions"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stats/parse/download/questions',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/apps

Example request:

curl --request GET \
    --get "/api/v1/apps" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/apps',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/enable

Example request:

curl --request POST \
    "/api/v1/apps/enable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appId\": \"officia\",
    \"direction\": false
}"

const url = new URL(
    "/api/v1/apps/enable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "appId": "officia",
    "direction": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/enable',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'appId' => 'officia',
            'direction' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/preauth-woo

Example request:

curl --request POST \
    "/api/v1/apps/preauth-woo" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/preauth-woo"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/preauth-woo',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/check

Example request:

curl --request POST \
    "/api/v1/apps/check" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/check"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/check',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/disable

Example request:

curl --request POST \
    "/api/v1/apps/disable" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appId\": \"et\",
    \"direction\": false
}"

const url = new URL(
    "/api/v1/apps/disable"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "appId": "et",
    "direction": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/disable',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'appId' => 'et',
            'direction' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/show

Example request:

curl --request POST \
    "/api/v1/apps/show" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/show"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/show',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/update

Example request:

curl --request POST \
    "/api/v1/apps/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/update"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/update',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get products from App

Example request:

curl --request POST \
    "/api/v1/apps/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/products',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/apps/products

Example request:

curl --request PUT \
    "/api/v1/apps/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"name\": \"lzmltovlosdspeciaiddnbhwicnxlerbmrr\",
        \"price\": 1099132.95,
        \"link\": \"http:\\/\\/www.ankunding.org\\/et-rerum-facilis-dolores-ducimus-nostrum-delectus-rerum\",
        \"image\": \"http:\\/\\/lowe.com\\/tempore-iusto-aut-necessitatibus-dolorum-possimus\",
        \"hasOnlyDefaultVariant\": false
    },
    \"eventId\": \"consequatur\",
    \"full\": false,
    \"variants\": [
        {
            \"name\": \"sapiente\",
            \"price\": 157.3,
            \"checked\": true
        }
    ]
}"

const url = new URL(
    "/api/v1/apps/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "data": {
        "name": "lzmltovlosdspeciaiddnbhwicnxlerbmrr",
        "price": 1099132.95,
        "link": "http:\/\/www.ankunding.org\/et-rerum-facilis-dolores-ducimus-nostrum-delectus-rerum",
        "image": "http:\/\/lowe.com\/tempore-iusto-aut-necessitatibus-dolorum-possimus",
        "hasOnlyDefaultVariant": false
    },
    "eventId": "consequatur",
    "full": false,
    "variants": [
        {
            "name": "sapiente",
            "price": 157.3,
            "checked": true
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/apps/products',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'data' => [
                'name' => 'lzmltovlosdspeciaiddnbhwicnxlerbmrr',
                'price' => 1099132.95,
                'link' => 'http://www.ankunding.org/et-rerum-facilis-dolores-ducimus-nostrum-delectus-rerum',
                'image' => 'http://lowe.com/tempore-iusto-aut-necessitatibus-dolorum-possimus',
                'hasOnlyDefaultVariant' => false,
            ],
            'eventId' => 'consequatur',
            'full' => false,
            'variants' => [
                [
                    'name' => 'sapiente',
                    'price' => 157.3,
                    'checked' => true,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

PUT api/v1/apps/products

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

data object optional

name string

Must be at least 3 characters. Example: lzmltovlosdspeciaiddnbhwicnxlerbmrr

reference string optional

price number

Example: 1099132.95

link string optional

Must be a valid URL. Example: http://www.ankunding.org/et-rerum-facilis-dolores-ducimus-nostrum-delectus-rerum

image string

Must be a valid URL. Example: http://lowe.com/tempore-iusto-aut-necessitatibus-dolorum-possimus

hasOnlyDefaultVariant boolean optional true false

Example: false

eventId string

Example: consequatur

full boolean optional true false

Example: false

variants object[] optional

name string optional

Example: sapiente

price number optional

Example: 157.3

checked boolean optional true false

Example: true

reference string optional

DELETE api/v1/apps/products

Example request:

curl --request DELETE \
    "/api/v1/apps/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/apps/products',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/products

Example request:

curl --request POST \
    "/api/v1/apps/shopify/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/products',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/auth

Example request:

curl --request POST \
    "/api/v1/apps/shopify/auth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/auth"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/auth',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/apps/shopify/deauth

Example request:

curl --request GET \
    --get "/api/v1/apps/shopify/deauth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/deauth"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/apps/shopify/deauth',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/apps/shopify/demo-page

Example request:

curl --request PUT \
    "/api/v1/apps/shopify/demo-page" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"voluptatem\"
}"

const url = new URL(
    "/api/v1/apps/shopify/demo-page"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "voluptatem"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/apps/shopify/demo-page',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'voluptatem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/apps/shopify/products

Example request:

curl --request PUT \
    "/api/v1/apps/shopify/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"laudantium\",
    \"products\": [
        {
            \"data\": {
                \"reference\": \"similique\",
                \"name\": \"opcjapinbcgoimt\",
                \"link\": \"http:\\/\\/grady.org\\/rerum-et-eum-adipisci-vitae-atque\",
                \"image\": \"http:\\/\\/oberbrunner.com\\/modi-sequi-non-rerum-consequatur-accusantium\",
                \"hasOnlyDefaultVariant\": true
            },
            \"variants\": [
                {
                    \"name\": \"et\",
                    \"price\": 40590903.981,
                    \"checked\": false
                }
            ]
        }
    ]
}"

const url = new URL(
    "/api/v1/apps/shopify/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "laudantium",
    "products": [
        {
            "data": {
                "reference": "similique",
                "name": "opcjapinbcgoimt",
                "link": "http:\/\/grady.org\/rerum-et-eum-adipisci-vitae-atque",
                "image": "http:\/\/oberbrunner.com\/modi-sequi-non-rerum-consequatur-accusantium",
                "hasOnlyDefaultVariant": true
            },
            "variants": [
                {
                    "name": "et",
                    "price": 40590903.981,
                    "checked": false
                }
            ]
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/apps/shopify/products',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'laudantium',
            'products' => [
                [
                    'data' => [
                        'reference' => 'similique',
                        'name' => 'opcjapinbcgoimt',
                        'link' => 'http://grady.org/rerum-et-eum-adipisci-vitae-atque',
                        'image' => 'http://oberbrunner.com/modi-sequi-non-rerum-consequatur-accusantium',
                        'hasOnlyDefaultVariant' => true,
                    ],
                    'variants' => [
                        [
                            'name' => 'et',
                            'price' => 40590903.981,
                            'checked' => false,
                        ],
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

PUT api/v1/apps/shopify/products

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

eventId string

Example: laudantium

products object[] optional

data object optional

reference string

Example: similique

name string

Must be at least 3 characters. Example: opcjapinbcgoimt

link string optional

Must be a valid URL. Example: http://grady.org/rerum-et-eum-adipisci-vitae-atque

image string

Must be a valid URL. Example: http://oberbrunner.com/modi-sequi-non-rerum-consequatur-accusantium

hasOnlyDefaultVariant boolean optional true false

Example: true

variants object[] optional

name string optional

Example: et

price number optional

Example: 40590903.981

reference string optional

checked boolean optional true false

Example: false

DELETE api/v1/apps/shopify/products

Example request:

curl --request DELETE \
    "/api/v1/apps/shopify/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"ullam\"
}"

const url = new URL(
    "/api/v1/apps/shopify/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "ullam"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/apps/shopify/products',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'ullam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/check-auth

Example request:

curl --request POST \
    "/api/v1/apps/shopify/check-auth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/check-auth"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/check-auth',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/apps/shopify/check-connection

Example request:

curl --request POST \
    "/api/v1/apps/shopify/check-connection" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/apps/shopify/check-connection"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/apps/shopify/check-connection',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/plans

Example request:

curl --request GET \
    --get "/api/v1/plans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/plans"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/plans',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

DELETE api/v1/plans

Example request:

curl --request DELETE \
    "/api/v1/plans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/plans"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/plans',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/plans/change

Example request:

curl --request POST \
    "/api/v1/plans/change" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"planId\": \"adipisci\"
}"

const url = new URL(
    "/api/v1/plans/change"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "planId": "adipisci"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/plans/change',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'planId' => 'adipisci',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/plans/resume

Example request:

curl --request GET \
    --get "/api/v1/plans/resume" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/plans/resume"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/plans/resume',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/invitations

Example request:

curl --request GET \
    --get "/api/v1/invitations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/invitations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/invitations',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

GET api/v1/invitations/forme

Example request:

curl --request GET \
    --get "/api/v1/invitations/forme" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/invitations/forme"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/invitations/forme',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PUT api/v1/invitations

Example request:

curl --request PUT \
    "/api/v1/invitations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"zieme.sharon@example.com\",
    \"events\": [
        \"osqercqboalxkbkozmrmzglzw\"
    ]
}"

const url = new URL(
    "/api/v1/invitations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "zieme.sharon@example.com",
    "events": [
        "osqercqboalxkbkozmrmzglzw"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/invitations',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'zieme.sharon@example.com',
            'events' => [
                'osqercqboalxkbkozmrmzglzw',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

PATCH api/v1/invitations

Example request:

curl --request PATCH \
    "/api/v1/invitations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 779353.286206,
    \"events\": [
        \"twpweysjritcarzoynchyhuhldkmlbnwicjrfehdegefipn\"
    ]
}"

const url = new URL(
    "/api/v1/invitations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": 779353.286206,
    "events": [
        "twpweysjritcarzoynchyhuhldkmlbnwicjrfehdegefipn"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    '/api/v1/invitations',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'id' => 779353.286206,
            'events' => [
                'twpweysjritcarzoynchyhuhldkmlbnwicjrfehdegefipn',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

DELETE api/v1/invitations

Example request:

curl --request DELETE \
    "/api/v1/invitations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/invitations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/invitations',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/invitations/accept

Example request:

curl --request POST \
    "/api/v1/invitations/accept" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/invitations/accept"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/invitations/accept',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/invitations/decline

Example request:

curl --request POST \
    "/api/v1/invitations/decline" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/invitations/decline"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/invitations/decline',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/stage/{eventSlug}/broadcast

Example request:

curl --request POST \
    "/api/v1/stage/sit/broadcast" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stage/sit/broadcast"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stage/sit/broadcast',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

DELETE api/v1/stage/{eventSlug}/broadcast

Example request:

curl --request DELETE \
    "/api/v1/stage/sit/broadcast" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stage/sit/broadcast"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/stage/sit/broadcast',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/stage/{eventSlug}/check

Example request:

curl --request POST \
    "/api/v1/stage/expedita/check" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stage/expedita/check"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stage/expedita/check',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

POST api/v1/stage/{eventSlug}/invite

Example request:

curl --request POST \
    "/api/v1/stage/omnis/invite" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/stage/omnis/invite"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/stage/omnis/invite',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Authorize a client to access the user's account.

Example request:

curl --request POST \
    "/api/v1/oauth/token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/token"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/oauth/token',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get all of the authorized tokens for the authenticated user.

Example request:

curl --request GET \
    --get "/api/v1/oauth/tokens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/tokens"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/oauth/tokens',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Delete the given token.

Example request:

curl --request DELETE \
    "/api/v1/oauth/tokens/quam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/tokens/quam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/oauth/tokens/quam',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get a fresh transient token cookie for the authenticated user.

Example request:

curl --request POST \
    "/api/v1/oauth/token/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/token/refresh"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/oauth/token/refresh',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get all of the clients for the authenticated user.

Example request:

curl --request GET \
    --get "/api/v1/oauth/clients" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/clients"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/oauth/clients',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Store a new client.

Example request:

curl --request POST \
    "/api/v1/oauth/clients" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/clients"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/oauth/clients',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Update the given client.

Example request:

curl --request PUT \
    "/api/v1/oauth/clients/qui" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/clients/qui"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->put(
    '/api/v1/oauth/clients/qui',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Delete the given client.

Example request:

curl --request DELETE \
    "/api/v1/oauth/clients/est" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/clients/est"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/oauth/clients/est',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get all of the available scopes for the application.

Example request:

curl --request GET \
    --get "/api/v1/oauth/scopes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/scopes"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/oauth/scopes',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get all of the personal access tokens for the authenticated user.

Example request:

curl --request GET \
    --get "/api/v1/oauth/personal-access-tokens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/personal-access-tokens"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/oauth/personal-access-tokens',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Create a new personal access token for the user.

Example request:

curl --request POST \
    "/api/v1/oauth/personal-access-tokens" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/personal-access-tokens"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/oauth/personal-access-tokens',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Delete the given token.

Example request:

curl --request DELETE \
    "/api/v1/oauth/personal-access-tokens/blanditiis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/oauth/personal-access-tokens/blanditiis"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/oauth/personal-access-tokens/blanditiis',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Studio

Delete message

Example request:

curl --request DELETE \
    "/api/v1/messages/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"thread_slug\": \"fuga\",
    \"message_id\": \"aperiam\"
}"

const url = new URL(
    "/api/v1/messages/delete"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "thread_slug": "fuga",
    "message_id": "aperiam"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/messages/delete',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'thread_slug' => 'fuga',
            'message_id' => 'aperiam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Get the stream for an event

Example request:

curl --request POST \
    "/api/v1/streams" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"event_id\": 22
}"

const url = new URL(
    "/api/v1/streams"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "event_id": 22
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/streams',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'event_id' => 22,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": {
        "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "event_id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
        "is_live_manual": false,
        "is_live": false,
        "roomId": null,
        "autojoin": false,
        "channel": "pK5A4WvhCO",
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzMWJ6MDFzdVFpN3IwMnc5dWMxdzQxVHpDZXVEcmppamNPWXQ1TVJsUHRLV1EiLCJhdWQiOiJ2IiwiZXhwIjoxNjgwODYyNDExLCJraWQiOiJwNDQ4UDAxQ3lwcDAwSUN3UDZ4Q1dUcGIzeUVrYzl4U2dvbGhXSVM1clJFSVEiLCJwbGF5YmFja19yZXN0cmljdGlvbl9pZCI6Imx6S2pDTjcwMHlkeU4wMWNsczc1S2lQMDBTNmRpc1E2c202dEJUSDN1QkZxcVEifQ.aQnDRMbOFxdLHcq8lEyj39et-lKntbaxHcdOciA7fS7Sk3C4dUjJGHB87jAHuUenOMujiDdWD5L4iNMpaMkeweD1qZNP-Rhsc4VDCtARA880n4gBej2V4gkOsYsO5Du1KHwNtLrLqp2uRvUDbSgX_o0qc15hk40TF-SGCJfhrWvtI4DAV5kxVyCVtgiH0asxlJIZkMJowQmip0TE4QzofShdJ0-9QVlz1iWW0VurCQLTtdGp2NmcEzXocCetHQBm7X7mwt8aJiUIUU_UuS8oD5csvOBBP4BnbovSg5x89l_c0kqHBwcZGzhMVzH2r8AAZ6ez41JtKIXpV4Wyr9m1FQ",
        "stream_key": "dacf1a91-a882-0a80-b138-636d40ff28e4",
        "playback": {
            "data": {
                "id": "gDqe1B0zJvx6yw9olAjmY8W3pKM47QZN",
                "playback_id": "31bz01suQi7r02w9uc1w41TzCeuDrjijcOYt5MRlPtKWQ"
            }
        },
        "space": null,
        "jwt": {
            "data": []
        }
    }
}

Received response:

Request failed with error:

Check for streaming minutes

requires authentication

Example request:

curl --request GET \
    --get "/api/v1/events/d09djkd9dw2232e2.../access" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/d09djkd9dw2232e2.../access"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->get(
    '/api/v1/events/d09djkd9dw2232e2.../access',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Promote product using serverside process

Example request:

curl --request POST \
    "/api/v1/events/nkErjN87ewWmVpdYKGAGKJ5Oo6BPlRZa/products/322/promote" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/events/nkErjN87ewWmVpdYKGAGKJ5Oo6BPlRZa/products/322/promote"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/events/nkErjN87ewWmVpdYKGAGKJ5Oo6BPlRZa/products/322/promote',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Delete question from channel

Example request:

curl --request POST \
    "/api/v1/questions/archive" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventSlug\": \"streams\",
    \"questionId\": \"xmzd9aducu88d...\"
}"

const url = new URL(
    "/api/v1/questions/archive"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventSlug": "streams",
    "questionId": "xmzd9aducu88d..."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/questions/archive',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventSlug' => 'streams',
            'questionId' => 'xmzd9aducu88d...',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

User Products

List all products

requires authentication

Example request:

curl --request POST \
    "/api/v1/profile/products/products-wo-event" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"jDnBP3Z2Ve1JxNbRKXdOmKGMzgwaQyk8\",
    \"term\": \"adatocqawqlzrniashcatcxlsvknxpdkuqyhuhusnwfdorybxfmcbhevzyxlspbaqcw\"
}"

const url = new URL(
    "/api/v1/profile/products/products-wo-event"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "jDnBP3Z2Ve1JxNbRKXdOmKGMzgwaQyk8",
    "term": "adatocqawqlzrniashcatcxlsvknxpdkuqyhuhusnwfdorybxfmcbhevzyxlspbaqcw"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile/products/products-wo-event',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'jDnBP3Z2Ve1JxNbRKXdOmKGMzgwaQyk8',
            'term' => 'adatocqawqlzrniashcatcxlsvknxpdkuqyhuhusnwfdorybxfmcbhevzyxlspbaqcw',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/profile/products/products-wo-event

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

eventId string

Hashed id of an event. Example: jDnBP3Z2Ve1JxNbRKXdOmKGMzgwaQyk8

term string optional

Must be at least 3 characters. Example: adatocqawqlzrniashcatcxlsvknxpdkuqyhuhusnwfdorybxfmcbhevzyxlspbaqcw

Create a product

requires authentication

Example request:

curl --request POST \
    "/api/v1/profile/products/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"eligendi\",
    \"link\": \"odit\",
    \"price\": \"est\",
    \"image\": [
        \"est\"
    ]
}"

const url = new URL(
    "/api/v1/profile/products/create"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "eligendi",
    "link": "odit",
    "price": "est",
    "image": [
        "est"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile/products/create',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'eligendi',
            'link' => 'odit',
            'price' => 'est',
            'image' => [
                'est',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Request

POST api/v1/profile/products/create

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

name string

Example: eligendi

link string

Example: odit

price decimal optional

Example: est

image string[]

Array of images files: jpeg,png,jpg,gif',

Update product

Example request:

curl --request POST \
    "/api/v1/profile/products/optio" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=p" \
    --form "link=aut" \
    --form "price=1" \
    --form "image[]=@/tmp/phpeijHCn"

const url = new URL(
    "/api/v1/profile/products/optio"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'p');
body.append('link', 'aut');
body.append('price', '1');
body.append('image[]', document.querySelector('input[name="image[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile/products/optio',
    [
        'headers' => [
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'p'
            ],
            [
                'name' => 'link',
                'contents' => 'aut'
            ],
            [
                'name' => 'price',
                'contents' => '1'
            ],
            [
                'name' => 'image[]',
                'contents' => fopen('/tmp/phpeijHCn', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "data": [
        {
            "id": 4,
            "name": "Test",
            "link": "https://google.com",
            "price": 2,
            "fixed_price": true,
            "currency": "USD",
            "reference": null,
            "bumped": false,
            "for_sale": false,
            "hasOnlyDefaultVariant": false,
            "isQuantityBased": false,
            "imageSource": null,
            "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
            "app": null,
            "variants": {
                "data": []
            },
            "quantity": {
                "total": null,
                "sold": 0,
                "available": 0,
                "no_limit": true
            }
        },
        {
            "id": 4,
            "name": "Test",
            "link": "https://google.com",
            "price": 2,
            "fixed_price": true,
            "currency": "USD",
            "reference": null,
            "bumped": false,
            "for_sale": false,
            "hasOnlyDefaultVariant": false,
            "isQuantityBased": false,
            "imageSource": null,
            "image": "https://cdn.streams.live/products/test-lzkw2ss9lw.png",
            "app": null,
            "variants": {
                "data": []
            },
            "quantity": {
                "total": null,
                "sold": 0,
                "available": 0,
                "no_limit": true
            }
        }
    ]
}

Received response:

Request failed with error:

Request

POST api/v1/profile/products/{productId}

Headers

Content-Type

Example: multipart/form-data

Accept

Example: application/json

URL Parameters

productId string

Example: optio

Body Parameters

name string

Must be between 1 and 60 characters. Example: p

link string

Example: aut

price number optional

Must be between 0 and 9999999. Example: 1

image file[]

Must be an image.

Delete user product

Example request:

curl --request DELETE \
    "/api/v1/profile/products/placeat" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/profile/products/placeat"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->delete(
    '/api/v1/profile/products/placeat',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (204):

[Empty response]

Received response:

Request failed with error:

Clone a product

Example request:

curl --request PATCH \
    "/api/v1/profile/products/tenetur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "/api/v1/profile/products/tenetur"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->patch(
    '/api/v1/profile/products/tenetur',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

List all products

requires authentication

Example request:

curl --request POST \
    "/api/v1/profile/nfts/products-wo-event" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"eventId\": \"jDnBP3Z2Ve1JxNbRKXdOmKGMzgwaQyk8\",
    \"term\": \"mijlhtiwvvf\"
}"

const url = new URL(
    "/api/v1/profile/nfts/products-wo-event"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "eventId": "jDnBP3Z2Ve1JxNbRKXdOmKGMzgwaQyk8",
    "term": "mijlhtiwvvf"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$response = $client->post(
    '/api/v1/profile/nfts/products-wo-event',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'eventId' => 'jDnBP3Z2Ve1JxNbRKXdOmKGMzgwaQyk8',
            'term' => 'mijlhtiwvvf',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "error": {
        "code": 404,
        "title": "Error",
        "message": "",
        "messages": []
    }
}

Received response:

Request failed with error:

Introduction

Authenticating requests

Authentication

User login

Request

Headers

Body Parameters

Social Login

Request

Headers

Body Parameters

User registration

Request

Headers

Body Parameters

Refresh token

Request

Headers

Body Parameters

Logout user

Request

Headers

Request reset password by email

Request

Headers

Body Parameters

Password reset by email verification

Request

Headers

Body Parameters

Channel

Clear cache for front office

Request

Headers

URL Parameters

List all channels

Request

Headers

Query Parameters

Forced stop

Request

Headers

URL Parameters

Create new channel

Request

Headers

Body Parameters

Show channels details

Request

Headers

URL Parameters

Update channel details.

Request

Headers

URL Parameters

Body Parameters

Delete a channel

Request

Headers

URL Parameters

Channel Medias

DELETE api/v1/events/media/{id}

Request

Headers

URL Parameters

POST api/v1/events/{id}/media/add

Request

Headers

URL Parameters

Body Parameters

POST api/v1/events/media/{id}/sync

Request

Headers

URL Parameters

POST api/v1/events/media/{id}/change-background

Request

Headers

URL Parameters

Change event cover

Request