MENU navbar-image

Introduction

#  Welcome to the RhinoCRM API documentation

Authenticating requests

To authenticate requests, include an Authorization header in the form "Basic {credentials}". The value of {credentials} should be your username/id and your password, joined with a colon (:), and then base64-encoded.

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

The x-consumer header is also required for all requests.

Both the credentials and consumer header are provided by Forteis.

.

Account-Agreement

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-agreement" \
    --header "Authorization: Basic <base64-encoded-value>" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: <consumer-token>" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-agreement"
);

const headers = {
    "Authorization": "Basic <base64-encoded-value>",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "<consumer-token>",
};

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

Request   

GET v1/account-agreement

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/account-agreement" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"usr_id\": null,
    \"act_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-agreement"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "usr_id": null,
    "act_id": null
};

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

Request   

POST v1/account-agreement

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

usr_id   string   

The usr_id of an existing record in the user table.

act_id   string   

The act_id of an existing record in the account table.

signed_contract   boolean  optional  
expiry_date   string  optional  

Must be a valid date in the format Y:m:d.

main_supplier   number  optional  

The tap_id of an existing record in the tap table.

secondary_supplier   number  optional  

The tap_id of an existing record in the tap table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-agreement/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-agreement/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-agreement/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account agreement.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/account-agreement/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-agreement/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

PUT v1/account-agreement/{id}

PATCH v1/account-agreement/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account agreement.

Body Parameters

usr_id   string  optional  

The usr_id of an existing record in the user table.

act_id   string  optional  

The act_id of an existing record in the account table.

signed_contract   boolean  optional  
expiry_date   string  optional  

Must be a valid date in the format Y:m:d.

main_supplier   number  optional  

The tap_id of an existing record in the tap table.

secondary_supplier   number  optional  

The tap_id of an existing record in the tap table.

id   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-agreement/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-agreement/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/account-agreement/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account agreement.

Account-Cocktails

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-cocktails" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-cocktails"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-cocktails

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-cocktails/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-cocktails/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/account-cocktails/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account cocktail.

Account-Contact-Positions

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-contact-positions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-contact-positions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-contact-positions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/account-contact-positions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"cop_name\": null,
    \"cop_order\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-contact-positions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "cop_name": null,
    "cop_order": null
};

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

Request   

POST v1/account-contact-positions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

cop_name   string   

Must not be greater than 255 characters.

cop_order   integer   

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-contact-positions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-contact-positions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-contact-positions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account contact position.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/account-contact-positions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"account_contact_positions\": null,
    \"cop_name\": null,
    \"cop_order\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-contact-positions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "account_contact_positions": null,
    "cop_name": null,
    "cop_order": null
};

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

Request   

PUT v1/account-contact-positions/{id}

PATCH v1/account-contact-positions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account contact position.

Body Parameters

account_contact_positions   string   

Must be between 1 and 11 digits.

cop_name   string   

Must not be greater than 255 characters.

cop_order   integer   

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-contact-positions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-contact-positions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/account-contact-positions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account contact position.

Account-Contacts

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-contacts" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-contacts"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-contacts

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/account-contacts" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"con_name\": null,
    \"act_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-contacts"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "con_name": null,
    "act_id": null
};

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

Request   

POST v1/account-contacts

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

con_name   string   

Must be between 1 and 50 characters.

con_telephone   string  optional  

Must be between 1 and 50 characters.

con_mobile   string  optional  

Must be between 1 and 50 characters.

con_email   string  optional  

Must be a valid email address. Must be between 1 and 50 characters.

con_res   string  optional  

Must be between 1 and 255 characters.

con_primary   string  optional  
Must be one of:
  • TRUE
  • FALSE
con_account_type   string  optional  
Must be one of:
  • On Premise
  • Off Premise
  • Integrated
con_dob   string  optional  

Must be a valid date in the format "Y-m-d".

con_editable   string  optional  
Must be one of:
  • true
  • false
act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

cop_id   integer  optional  

The cop_id of an existing record in the contact_position table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-contacts/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-contacts/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-contacts/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account contact.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/account-contacts/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"account_contacts\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-contacts/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "account_contacts": null
};

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

Request   

PUT v1/account-contacts/{id}

PATCH v1/account-contacts/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account contact.

Body Parameters

account_contacts   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

con_name   string  optional  

Must be between 1 and 50 characters.

con_telephone   string  optional  

Must be between 1 and 50 characters.

con_mobile   string  optional  

Must be between 1 and 50 characters.

con_email   string  optional  

Must be a valid email address. Must be between 1 and 50 characters.

con_res   string  optional  

Must be between 1 and 255 characters.

con_primary   string  optional  
Must be one of:
  • TRUE
  • FALSE
con_account_type   string  optional  
Must be one of:
  • On Premise
  • Off Premise
  • Integrated
con_dob   string  optional  

Must be a valid date in the format "Y-m-d".

con_editable   string  optional  
Must be one of:
  • true
  • false
act_id   string  optional  

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

cop_id   integer  optional  

The cop_id of an existing record in the contact_position table.

DELETE v1/account-contacts/{id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-contacts/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-contacts/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/account-contacts/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account contact.

Account-Deliveries

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-deliveries" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-deliveries"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-deliveries

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/account-deliveries" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"act_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-deliveries"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "act_id": null
};

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

Request   

POST v1/account-deliveries

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

address_line_1   string  optional  

Must be between 1 and 255 characters.

address_line_2   string  optional  

Must be between 1 and 255 characters.

post_code   string  optional  

Must be between 1 and 5 characters.

suburb   string  optional  

Must be between 1 and 255 characters.

state   string  optional  

The sta_name of an existing record in the state table.

country   string  optional  

Must be between 1 and 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-deliveries/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-deliveries/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-deliveries/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account delivery.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/account-deliveries/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"account_deliveries\": null,
    \"act_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-deliveries/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "account_deliveries": null,
    "act_id": null
};

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

Request   

PUT v1/account-deliveries/{id}

PATCH v1/account-deliveries/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account delivery.

Body Parameters

account_deliveries   string   

Must be between 1 and 11 digits.

act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

address_line_1   string  optional  

Must be between 1 and 255 characters.

address_line_2   string  optional  

Must be between 1 and 255 characters.

post_code   string  optional  

Must be between 1 and 5 characters.

suburb   string  optional  

Must be between 1 and 255 characters.

state   string  optional  

The sta_name of an existing record in the state table.

country   string  optional  

Must be between 1 and 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-deliveries/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-deliveries/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/account-deliveries/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account delivery.

Account-Objective-History

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-objective-history" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-objective-history"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-objective-history

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-objective-history/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-objective-history/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/account-objective-history/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account objective history.

Account-Objectives

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-objectives" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-objectives"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-objectives

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/account-objectives" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"aob_name\": null,
    \"act_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-objectives"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "aob_name": null,
    "act_id": null
};

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

Request   

POST v1/account-objectives

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

aob_name   string   

Must not be greater than 255 characters.

aob_date_completed   string  optional  

Must be a valid date in the format Y:m:d.

act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

cob_id   integer  optional  

The cob_id of an existing record in the company_objective table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-objectives/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-objectives/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-objectives/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account objective.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/account-objectives/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"account_objectives\": null,
    \"aob_name\": null,
    \"aob_date_completed\": null,
    \"act_id\": null,
    \"cob_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-objectives/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "account_objectives": null,
    "aob_name": null,
    "aob_date_completed": null,
    "act_id": null,
    "cob_id": null
};

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

Request   

PUT v1/account-objectives/{id}

PATCH v1/account-objectives/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account objective.

Body Parameters

account_objectives   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

aob_name   string   

Must not be greater than 255 characters.

aob_date_completed   string   

Must be a valid date in the format Y:m:d.

act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

cob_id   integer   

The cob_id of an existing record in the company_objective table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-objectives/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-objectives/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/account-objectives/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account objective.

Account-Territories

Delete

requires authentication

We will be deleting via account id's, if you provide account id, all of the terrirotories connected will be deleted

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-territories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"accounts\": null,
    \"account\": [
        {
            \"account_id\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-territories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "accounts": null,
    "account": [
        {
            "account_id": null
        }
    ]
};

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

Request   

DELETE v1/account-territories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

accounts   object   

Must have at least 1 items.

account   object[]  optional  
account_id   string   

The account_id of an existing record in the account_territory_link table.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-territories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-territories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-territories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-territories/account//territory/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-territories/account//territory/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-territories/account/{account}/territory/{territory}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

account   string   

The account.

territory   string   

The territory.

Retrieve by account

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-territories/account/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-territories/account/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-territories/account/{account}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

account   string   

The account.

Retrieve by territory

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-territories/territory/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-territories/territory/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-territories/territory/{territory}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

territory   string   

The territory.

Account-Wholesalers

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-wholesalers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/account-wholesalers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-wholesalers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/account-wholesalers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"act_id\": null,
    \"who_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-wholesalers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "act_id": null,
    "who_id": null
};

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

Request   

POST v1/account-wholesalers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

who_id   string   

Must be between 1 and 11 digits. The who_id of an existing record in the wholesaler table.

who_code   string  optional  

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 20 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/account-wholesalers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-wholesalers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/account-wholesalers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account wholesaler.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/account-wholesalers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"account_wholesalers\": null,
    \"act_id\": null,
    \"who_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/account-wholesalers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "account_wholesalers": null,
    "act_id": null,
    "who_id": null
};

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

Request   

PUT v1/account-wholesalers/{id}

PATCH v1/account-wholesalers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account wholesaler.

Body Parameters

account_wholesalers   string   

Must be between 1 and 11 digits.

act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

who_id   string   

Must be between 1 and 11 digits. The who_id of an existing record in the wholesaler table.

who_code   string  optional  

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 20 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/account-wholesalers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/account-wholesalers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/account-wholesalers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account wholesaler.

Accounts

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/accounts" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/accounts"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/accounts

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/accounts" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"act_name\": null,
    \"usr_id\": null,
    \"act_serviced\": null,
    \"sta_name\": null,
    \"wholesaler\": [
        {
            \"who_id\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/accounts"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "act_name": null,
    "usr_id": null,
    "act_serviced": null,
    "sta_name": null,
    "wholesaler": [
        {
            "who_id": null
        }
    ]
};

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

Request   

POST v1/accounts

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

act_reference_id   string  optional  

Must not be greater than 36 characters.

act_name   string   

Must not be greater than 255 characters.

usr_id   string   

The usr_id of an existing record in the user table.

act_serviced   string   
Must be one of:
  • TRUE
  • FALSE
act_type   string  optional  
Must be one of:
  • On Premise
  • Off Premise
  • Integrated
osg_id   string  optional  

The osg_id of an existing record in the ownership_group table.

sta_name   string   

The sta_name of an existing record in the state table.

act_address   string  optional  

Must not be greater than 255 characters.

act_suburb   string  optional  

Must not be greater than 255 characters.

act_city   string  optional  

Must not be greater than 255 characters.

act_country   string  optional  

Must not be greater than 255 characters.

act_post_code   string  optional  

Must not be greater than 10 characters.

act_phone   string  optional  

Must not be greater than 255 characters.

act_email   string  optional  

Must be a valid email address. Must not be greater than 100 characters.

who_id   string  optional  

The who_id of an existing record in the wholesaler table.

who_id_2   string  optional  

The who_id of an existing record in the wholesaler table.

ban_id   string  optional  

The ban_id of an existing record in the banner table.

ban_id_2   string  optional  

The ban_id of an existing record in the banner table.

act_wholesaler_no   string  optional  

Must not be greater than 20 characters.

act_wholesaler_no_2   string  optional  

Must not be greater than 20 characters.

act_account_balance   number  optional  
act_credit_balance   number  optional  
act_equipment_balance   number  optional  
act_keg_discount   string  optional  
Must be one of:
  • Yes
  • No
act_pallet_rebate   string  optional  
Must be one of:
  • Yes
  • No
act_credit_limit   number  optional  
act_additional_1   string  optional  

Must not be greater than 255 characters.

act_additional_2   string  optional  

Must not be greater than 255 characters.

act_additional_3   string  optional  

Must not be greater than 255 characters.

act_additional_4   string  optional  

Must not be greater than 255 characters.

gra_id   string  optional  

The gra_id of an existing record in the grade table.

cycle_id   string  optional  

The id of an existing record in the cycle table.

act_opening_hours   string  optional  

Must not be greater than 255 characters.

wholesaler   object[]  optional  

Must have at least 1 items. Must not have more than 50 items.
who_id   string   

Must be between 1 and 11 digits. The who_id of an existing record in the wholesaler table.

who_code   string  optional  

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 20 characters.

delivery   object[]  optional  

Must have at least 1 items. Must not have more than 50 items.
address_line_1   string  optional  

Must be between 1 and 255 characters.

address_line_2   string  optional  

Must be between 1 and 255 characters.

post_code   string  optional  

Must be between 1 and 4 digits.

suburb   string  optional  

Must not be greater than 255 characters.

state   string  optional  

The sta_name of an existing record in the state table.

country   string  optional  

Must be between 1 and 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/accounts/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/accounts/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/accounts/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/accounts/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"accounts\": null,
    \"act_name\": null,
    \"usr_id\": null,
    \"act_serviced\": null,
    \"sta_name\": null,
    \"wholesaler\": [
        {
            \"who_id\": null
        }
    ],
    \"delivery\": [
        {
            \"adl_id\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/accounts/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "accounts": null,
    "act_name": null,
    "usr_id": null,
    "act_serviced": null,
    "sta_name": null,
    "wholesaler": [
        {
            "who_id": null
        }
    ],
    "delivery": [
        {
            "adl_id": null
        }
    ]
};

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

Request   

PUT v1/accounts/{id}

PATCH v1/accounts/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account.

Body Parameters

accounts   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

act_reference_id   string  optional  

Must not be greater than 36 characters.

act_name   string   

Must not be greater than 255 characters.

usr_id   string   

The usr_id of an existing record in the user table.

act_serviced   string   
Must be one of:
  • TRUE
  • FALSE
act_type   string  optional  
Must be one of:
  • On Premise
  • Off Premise
  • Integrated
osg_id   string  optional  

The osg_id of an existing record in the ownership_group table.

sta_name   string   

The sta_name of an existing record in the state table.

act_address   string  optional  

Must not be greater than 255 characters.

act_suburb   string  optional  

Must not be greater than 255 characters.

act_city   string  optional  

Must not be greater than 255 characters.

act_country   string  optional  

Must not be greater than 255 characters.

act_post_code   string  optional  

Must not be greater than 10 characters.

act_phone   string  optional  

Must not be greater than 255 characters.

act_email   string  optional  

Must be a valid email address. Must not be greater than 100 characters.

who_id   string  optional  

The who_id of an existing record in the wholesaler table.

who_id_2   string  optional  

The who_id of an existing record in the wholesaler table.

ban_id   string  optional  

The ban_id of an existing record in the banner table.

ban_id_2   string  optional  

The ban_id of an existing record in the banner table.

act_wholesaler_no   string  optional  

Must not be greater than 20 characters.

act_wholesaler_no_2   string  optional  

Must not be greater than 20 characters.

act_account_balance   number  optional  
act_credit_balance   number  optional  
act_equipment_balance   number  optional  
act_keg_discount   string  optional  
Must be one of:
  • Yes
  • No
act_pallet_rebate   string  optional  
Must be one of:
  • Yes
  • No
act_credit_limit   number  optional  
act_additional_1   string  optional  

Must not be greater than 255 characters.

act_additional_2   string  optional  

Must not be greater than 255 characters.

act_additional_3   string  optional  

Must not be greater than 255 characters.

act_additional_4   string  optional  

Must not be greater than 255 characters.

gra_id   string  optional  

The gra_id of an existing record in the grade table.

cycle_id   string  optional  

The id of an existing record in the cycle table.

act_opening_hours   string  optional  

Must not be greater than 255 characters.

wholesaler   object[]  optional  

Must have at least 1 items. Must not have more than 50 items.
who_id   string   

Must be between 1 and 11 digits. The who_id of an existing record in the wholesaler table.

who_code   string  optional  

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 20 characters.

delivery   object[]  optional  

Must have at least 1 items. Must not have more than 50 items.
adl_id   string   

Must be between 1 and 11 digits. The adl_id of an existing record in the account_delivery table.

address_line_1   string  optional  

Must be between 1 and 255 characters.

address_line_2   string  optional  

Must be between 1 and 255 characters.

post_code   string  optional  

Must be between 1 and 4 digits.

suburb   string  optional  

Must not be greater than 255 characters.

state   string  optional  

The sta_name of an existing record in the state table.

country   string  optional  

Must be between 1 and 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/accounts/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/accounts/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/accounts/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the account.

Update multiple

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/accounts" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"upsert\": null,
    \"account\": [
        {
            \"act_id\": null,
            \"act_name\": null,
            \"usr_id\": null,
            \"act_serviced\": null,
            \"sta_name\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/accounts"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "upsert": null,
    "account": [
        {
            "act_id": null,
            "act_name": null,
            "usr_id": null,
            "act_serviced": null,
            "sta_name": null
        }
    ]
};

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

Request   

PUT v1/accounts

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

upsert   string   
Must be one of:
  • 1
  • 0
account   object[]   

Must have at least 1 items. Must not have more than 50 items.
act_id   string   

The act_id of an existing record in the account table.

act_reference_id   string  optional  

Must not be greater than 36 characters.

act_name   string   

Must not be greater than 255 characters.

usr_id   string   

The usr_id of an existing record in the user table.

act_serviced   string   
Must be one of:
  • TRUE
  • FALSE
act_type   string  optional  
Must be one of:
  • On Premise
  • Off Premise
  • Integrated
osg_id   string  optional  

The osg_id of an existing record in the ownership_group table.

sta_name   string   

The sta_name of an existing record in the state table.

act_address   string  optional  

Must not be greater than 255 characters.

act_suburb   string  optional  

Must not be greater than 255 characters.

act_city   string  optional  

Must not be greater than 255 characters.

act_country   string  optional  

Must not be greater than 255 characters.

act_post_code   string  optional  

Must not be greater than 10 characters.

act_phone   string  optional  

Must not be greater than 255 characters.

act_email   string  optional  

Must be a valid email address. Must not be greater than 100 characters.

who_id   string  optional  

The who_id of an existing record in the wholesaler table.

who_id_2   string  optional  

The who_id of an existing record in the wholesaler table.

ban_id   string  optional  

The ban_id of an existing record in the banner table.

ban_id_2   string  optional  

The ban_id of an existing record in the banner table.

act_wholesaler_no   string  optional  

Must not be greater than 20 characters.

act_wholesaler_no_2   string  optional  

Must not be greater than 20 characters.

act_account_balance   number  optional  
act_credit_balance   number  optional  
act_equipment_balance   number  optional  
act_keg_discount   string  optional  
Must be one of:
  • Yes
  • No
act_pallet_rebate   string  optional  
Must be one of:
  • Yes
  • No
act_credit_limit   number  optional  
act_additional_1   string  optional  

Must not be greater than 255 characters.

act_additional_2   string  optional  

Must not be greater than 255 characters.

act_additional_3   string  optional  

Must not be greater than 255 characters.

act_additional_4   string  optional  

Must not be greater than 255 characters.

gra_id   string  optional  

The gra_id of an existing record in the grade table.

act_opening_hours   string  optional  

Must not be greater than 255 characters.

wholesaler   object[]  optional  

Must have at least 1 items. Must not have more than 50 items.
who_id   string  optional  

Must be between 1 and 11 digits. The who_id of an existing record in the wholesaler table.

who_code   string  optional  

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 20 characters.

delivery   object[]  optional  

Must have at least 1 items. Must not have more than 50 items.
adl_id   string  optional  

Must be between 1 and 11 digits. The adl_id of an existing record in the account_delivery table.

address_line_1   string  optional  

Must be between 1 and 255 characters.

address_line_2   string  optional  

Must be between 1 and 255 characters.

post_code   string  optional  

Must be between 1 and 4 digits.

suburb   string  optional  

Must not be greater than 255 characters.

state   string  optional  

The sta_name of an existing record in the state table.

country   string  optional  

Must be between 1 and 255 characters.

gen1_id   string  optional  

The gen1_id of an existing record in the generic_1 table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/accounts-cascading-delete" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"accounts\": null,
    \"account\": [
        {
            \"act_id\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/accounts-cascading-delete"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "accounts": null,
    "account": [
        {
            "act_id": null
        }
    ]
};

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

Request   

DELETE v1/accounts-cascading-delete

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

accounts   object   

Must have at least 1 items.

account   object[]  optional  
act_id   string   

The act_id of an existing record in the account table.

Admin-Module-Groups

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/admin-module-groups" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/admin-module-groups"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/admin-module-groups

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/admin-module-groups" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"admin_module_id\": null,
    \"module_group_id\": null,
    \"active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/admin-module-groups"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "admin_module_id": null,
    "module_group_id": null,
    "active": null
};

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

Request   

POST v1/admin-module-groups

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

admin_module_id   integer   

The id of an existing record in the admin_modules table.

module_group_id   integer   

The id of an existing record in the module_groups table.

active   integer   
Must be one of:
  • 1
  • 0

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/admin-module-groups/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/admin-module-groups/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/admin-module-groups/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the admin module group.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/admin-module-groups/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"admin_module_groups\": null,
    \"admin_module_id\": null,
    \"module_group_id\": null,
    \"active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/admin-module-groups/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "admin_module_groups": null,
    "admin_module_id": null,
    "module_group_id": null,
    "active": null
};

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

Request   

PUT v1/admin-module-groups/{id}

PATCH v1/admin-module-groups/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the admin module group.

Body Parameters

admin_module_groups   string   

Must be between 1 and 11 digits.

admin_module_id   integer   

The id of an existing record in the admin_modules table.

module_group_id   integer   

The id of an existing record in the module_groups table.

active   integer   
Must be one of:
  • 1
  • 0

Admin-Modules

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/admin-modules" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/admin-modules"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/admin-modules

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/admin-modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/admin-modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/admin-modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the admin module.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/admin-modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"admin_modules\": null,
    \"active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/admin-modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "admin_modules": null,
    "active": null
};

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

Request   

PUT v1/admin-modules/{id}

PATCH v1/admin-modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the admin module.

Body Parameters

admin_modules   string   

Must be between 1 and 11 digits.

active   integer   
Must be one of:
  • 0
  • 1

Answers

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/answers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/answers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/answers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/answers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"answer\": null,
    \"question_id\": null,
    \"user_id\": null,
    \"account_id\": null,
    \"call_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/answers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "answer": null,
    "question_id": null,
    "user_id": null,
    "account_id": null,
    "call_id": null
};

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

Request   

POST v1/answers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

answer   string   

Must not be greater than 255 characters.

question_id   integer   

The id of an existing record in the questions table.

user_id   string   

The usr_id of an existing record in the user table.

account_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

call_id   string   

The cal_id of an existing record in the jpcall table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the answer.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"answers\": null,
    \"answer\": null,
    \"question_id\": null,
    \"user_id\": null,
    \"account_id\": null,
    \"call_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "answers": null,
    "answer": null,
    "question_id": null,
    "user_id": null,
    "account_id": null,
    "call_id": null
};

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

Request   

PUT v1/answers/{id}

PATCH v1/answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the answer.

Body Parameters

answers   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

answer   string   

Must not be greater than 255 characters.

question_id   integer   

The id of an existing record in the questions table.

user_id   string   

The usr_id of an existing record in the user table.

account_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

call_id   string   

The cal_id of an existing record in the jpcall table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the answer.

Areas

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/areas" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/areas"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/areas

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/areas" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"are_name\": null,
    \"are_short_name\": null,
    \"are_order\": null,
    \"sac_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/areas"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "are_name": null,
    "are_short_name": null,
    "are_order": null,
    "sac_id": null
};

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

Request   

POST v1/areas

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

are_name   string   

Must not be greater than 255 characters.

are_short_name   string   

Must not be greater than 100 characters.

are_order   integer   
sac_id   integer   

The sac_id of an existing record in the selling_area_category table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/areas/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/areas/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/areas/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the area.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/areas/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"areas\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/areas/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "areas": null
};

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

Request   

PUT v1/areas/{id}

PATCH v1/areas/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the area.

Body Parameters

areas   string   

Must be between 1 and 11 digits.

are_name   string  optional  

Must not be greater than 255 characters.

are_short_name   string  optional  

Must not be greater than 100 characters.

are_order   integer  optional  
sac_id   integer  optional  

The sac_id of an existing record in the selling_area_category table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/areas/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/areas/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/areas/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the area.

Asset-Register-Types

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-register-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-register-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/asset-register-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"art_name\": null,
    \"art_active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "art_name": null,
    "art_active": null
};

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

Request   

POST v1/asset-register-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

art_name   string   

Must not be greater than 255 characters.

art_active   integer   
Must be one of:
  • 1
  • 0

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-register-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-register-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset register type.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/asset-register-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

PUT v1/asset-register-types/{id}

PATCH v1/asset-register-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset register type.

Body Parameters

art_name   string  optional  

Must not be greater than 255 characters.

art_active   integer  optional  
Must be one of:
  • 1
  • 0

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/asset-register-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/asset-register-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset register type.

Asset-Register-Types-Selections

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-register-type-selections" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-type-selections"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-register-type-selections

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/asset-register-type-selections" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"asg_id\": null,
    \"art_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-type-selections"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "asg_id": null,
    "art_id": null
};

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

Request   

POST v1/asset-register-type-selections

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

asg_id   string   

Must contain only letters, numbers, dashes and underscores. The asg_id of an existing record in the asset_register table. Must be between 1 and 36 characters.

art_id   string   

Must be between 1 and 11 digits. The art_id of an existing record in the asset_register_type table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-register-type-selections/asset-register//type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-type-selections/asset-register//type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-register-type-selections/asset-register/{asset}/type/{type}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

asset   string   
type   string   

The type.

Retrieve by asset

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-register-type-selections/asset-register/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-type-selections/asset-register/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-register-type-selections/asset-register/{asset}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

asset   string   

Retrieve by type

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-register-type-selections/type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-type-selections/type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-register-type-selections/type/{type}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

type   string   

The type.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/asset-register-type-selections/asset-register//type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"asset\": null,
    \"type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-type-selections/asset-register//type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "asset": null,
    "type": null
};

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

Request   

PUT v1/asset-register-type-selections/asset-register/{asset}/type/{type}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

asset   string   
type   string   

The type.

Body Parameters

asset   string   

Must contain only letters, numbers, dashes and underscores. The asg_id of an existing record in the asset_register table. Must be between 1 and 36 characters.

type   string   

Must be between 1 and 11 digits. The art_id of an existing record in the asset_register_type table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/asset-register-type-selections/asset-register//type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-register-type-selections/asset-register//type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/asset-register-type-selections/asset-register/{asset}/type/{type}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

asset   string   
type   string   

The type.

Asset-Registers

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-registers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-registers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-registers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/asset-registers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"asg_status\": null,
    \"asg_date\": null,
    \"act_id\": null,
    \"pro_id\": null,
    \"bnd_id\": null,
    \"asg_opening_hours\": null,
    \"asg_closing_hours\": null,
    \"asg_address\": null,
    \"con_id\": null,
    \"asg_phone\": null,
    \"asg_delivery\": null,
    \"usr_id\": null,
    \"asg_notes\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-registers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "asg_status": null,
    "asg_date": null,
    "act_id": null,
    "pro_id": null,
    "bnd_id": null,
    "asg_opening_hours": null,
    "asg_closing_hours": null,
    "asg_address": null,
    "con_id": null,
    "asg_phone": null,
    "asg_delivery": null,
    "usr_id": null,
    "asg_notes": null
};

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

Request   

POST v1/asset-registers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

asg_status   string   
Must be one of:
  • Active
  • Inactive
asg_date   string   

Must not be greater than 10 characters.

act_id   string   

The act_id of an existing record in the account table.

pro_id   integer   

The pro_id of an existing record in the product table.

bnd_id   integer   

The bnd_id of an existing record in the brand table.

asg_opening_hours   string   

Must not be greater than 255 characters.

asg_closing_hours   string   

Must not be greater than 255 characters.

asg_address   string   

Must not be greater than 255 characters.

con_id   string   

The con_id of an existing record in the contact table.

asg_phone   string   

Must not be greater than 255 characters.

asg_email   string  optional  

Must not be greater than 255 characters.

asg_delivery   string   
Must be one of:
  • Drop Off
  • Pick Up
usr_id   string   

The usr_id of an existing record in the user table.

asg_notes   string   

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-registers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-registers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-registers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset register.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/asset-registers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-registers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

PUT v1/asset-registers/{id}

PATCH v1/asset-registers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset register.

Body Parameters

asg_status   string  optional  
Must be one of:
  • Active
  • Inactive
asg_date   string  optional  

Must not be greater than 10 characters.

act_id   string  optional  

The act_id of an existing record in the account table.

pro_id   integer  optional  

The pro_id of an existing record in the product table.

bnd_id   integer  optional  

The bnd_id of an existing record in the brand table.

asg_opening_hours   string  optional  

Must not be greater than 255 characters.

asg_closing_hours   string  optional  

Must not be greater than 255 characters.

asg_address   string  optional  

Must not be greater than 255 characters.

con_id   string  optional  

The con_id of an existing record in the contact table.

asg_phone   string  optional  

Must not be greater than 255 characters.

asg_email   string  optional  

Must not be greater than 255 characters.

asg_delivery   string  optional  
Must be one of:
  • Drop Off
  • Pick Up
usr_id   string  optional  

The usr_id of an existing record in the user table.

asg_notes   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/asset-registers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-registers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/asset-registers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset register.

Asset-Types

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/asset-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/asset-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/asset-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/asset-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset type.

Assets

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/assets" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/assets"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/assets

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/assets" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ass_name\": null,
    \"ass_start_date\": null,
    \"ass_end_date\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/assets"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ass_name": null,
    "ass_start_date": null,
    "ass_end_date": null
};

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

Request   

POST v1/assets

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

ass_name   string   

The name of an existing record in the asset_type table. Must not be greater than 255 characters.

ass_volume   number  optional  
ass_investment   number  optional  
ass_start_date   string   

Must be a valid date in the format Y:m:d.

ass_end_date   string   

Must be a valid date in the format Y:m:d.

ass_note   string  optional  
ass_achieved   string  optional  
Must be one of:
  • FALSE
  • TRUE
ass_achieved_date   string  optional  

Must be a valid date in the format Y:m:d.

pro_id   integer  optional  

The pro_id of an existing record in the product table.

act_id   string  optional  

The act_id of an existing record in the account table.

osg_id   string  optional  

The osg_id of an existing record in the ownership_group table.

who_id   string  optional  

The who_id of an existing record in the wholesaler table.

bnd_id   integer  optional  

The bnd_id of an existing record in the brand table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/assets/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/assets/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/assets/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/assets/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ass_start_date\": null,
    \"ass_end_date\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/assets/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ass_start_date": null,
    "ass_end_date": null
};

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

Request   

PUT v1/assets/{id}

PATCH v1/assets/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset.

Body Parameters

ass_name   string  optional  

The name of an existing record in the asset_type table. Must not be greater than 255 characters.

ass_volume   number  optional  
ass_investment   number  optional  
ass_start_date   string   

Must be a valid date in the format Y:m:d.

ass_end_date   string   

Must be a valid date in the format Y:m:d.

ass_note   string  optional  
ass_achieved   string  optional  
Must be one of:
  • FALSE
  • TRUE
ass_achieved_date   string  optional  

Must be a valid date in the format Y:m:d.

pro_id   integer  optional  

The pro_id of an existing record in the product table.

act_id   string  optional  

The act_id of an existing record in the account table.

osg_id   string  optional  

The osg_id of an existing record in the ownership_group table.

who_id   string  optional  

The who_id of an existing record in the wholesaler table.

bnd_id   integer  optional  

The bnd_id of an existing record in the brand table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/assets/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/assets/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/assets/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the asset.

Banner-States

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/banner-states/banner//state/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/banner-states/banner//state/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/banner-states/banner/{banner}/state/{state}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

banner   string   

The banner.

state   string   

The state.

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/banner-states/banner/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/banner-states/banner/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/banner-states/banner/{banner}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

banner   string   

The banner.

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/banner-states/state/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/banner-states/state/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/banner-states/state/{state}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

state   string   

The state.

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/banner-states/banner//state/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"banner\": null,
    \"state\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/banner-states/banner//state/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "banner": null,
    "state": null
};

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

Request   

PUT v1/banner-states/banner/{banner}/state/{state}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

banner   string   

The banner.

state   string   

The state.

Body Parameters

banner   string   

Must be between 1 and 11 digits. The ban_id of an existing record in the banner table.

state   string   

The sta_name of an existing record in the state table.

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/banner-states/banner//state/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/banner-states/banner//state/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/banner-states/banner/{banner}/state/{state}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

banner   string   

The banner.

state   string   

The state.

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/banner-states" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/banner-states"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/banner-states

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/banner-states" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ban_id\": null,
    \"sta_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/banner-states"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ban_id": null,
    "sta_name": null
};

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

Request   

POST v1/banner-states

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

ban_id   string   

Must be between 1 and 11 digits. The ban_id of an existing record in the banner table.

sta_name   string   

The sta_name of an existing record in the state table.

Banners

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/banners" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/banners"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/banners

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/banners" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ban_name\": null,
    \"sta_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/banners"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ban_name": null,
    "sta_name": null
};

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

Request   

POST v1/banners

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

ban_name   string   

Must not be greater than 255 characters.

sta_name   string   

Must not be greater than 3 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/banners/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/banners/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/banners/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the banner.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/banners/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"banners\": null,
    \"ban_name\": null,
    \"sta_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/banners/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "banners": null,
    "ban_name": null,
    "sta_name": null
};

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

Request   

PUT v1/banners/{id}

PATCH v1/banners/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the banner.

Body Parameters

banners   string   

Must be between 1 and 11 digits.

ban_name   string   

Must not be greater than 255 characters.

sta_name   string   

Must not be greater than 3 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/banners/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/banners/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/banners/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the banner.

Bonus-Types

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/bonus-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/bonus-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/bonus-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/bonus-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/bonus-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null
};

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

Request   

POST v1/bonus-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 45 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/bonus-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/bonus-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/bonus-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the bonus type.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/bonus-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"bonus_types\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/bonus-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "bonus_types": null
};

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

Request   

PUT v1/bonus-types/{id}

PATCH v1/bonus-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the bonus type.

Body Parameters

bonus_types   string   

Must be between 1 and 11 digits.

name   string  optional  

Must not be greater than 45 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/bonus-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/bonus-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/bonus-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the bonus type.

Brands

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/brands" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/brands"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/brands

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/brands" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"bnd_name\": null,
    \"is_active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/brands"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "bnd_name": null,
    "is_active": null
};

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

Request   

POST v1/brands

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

bnd_name   string   

Must not be greater than 30 characters.

is_active   boolean   
description   string  optional  

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/brands/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/brands/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/brands/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the brand.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/brands/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"brands\": null,
    \"is_active\": null,
    \"bnd_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/brands/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "brands": null,
    "is_active": null,
    "bnd_name": null
};

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

Request   

PUT v1/brands/{id}

PATCH v1/brands/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the brand.

Body Parameters

brands   string   

Must be between 1 and 11 digits.

is_active   boolean   
description   string  optional  

Must not be greater than 255 characters.

bnd_name   string   

Must not be greater than 30 characters.

Call-Notes

Retrieve by account

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/call-notes/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/call-notes/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/call-notes/{account}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

account   string   

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/call-notes" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/call-notes"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/call-notes

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/call-notes" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"his_info\": null,
    \"cal_id\": null,
    \"his_date\": null,
    \"act_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/call-notes"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "his_info": null,
    "cal_id": null,
    "his_date": null,
    "act_id": null
};

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

Request   

POST v1/call-notes

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

his_info   string   
cal_id   string   

The cal_id of an existing record in the jpcall table.

his_date   string   

Must be a valid date in the format Y:m:d.

act_id   string   

The act_id of an existing record in the account table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/call-notes/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/call-notes/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/call-notes/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the call note.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/call-notes/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"call_notes\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/call-notes/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "call_notes": null
};

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

Request   

PUT v1/call-notes/{id}

PATCH v1/call-notes/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the call note.

Body Parameters

call_notes   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

his_info   string  optional  
cal_id   string  optional  

The cal_id of an existing record in the jpcall table.

his_date   string  optional  

Must be a valid date in the format Y:m:d.

act_id   string  optional  

The act_id of an existing record in the account table.

his_id   string  optional  

Call-Types

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/call-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/call-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/call-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/call-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/call-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/call-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the call type.

CallAudit

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/call-audit" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/call-audit"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/call-audit

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/call-audit/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/call-audit/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/call-audit/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the call audit.

Calls

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/calls" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/calls"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/calls

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/calls" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"act_id\": null,
    \"usr_id\": null,
    \"cat_id\": null,
    \"cal_date\": null,
    \"cal_additional_detail\": null,
    \"cal_position\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/calls"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "act_id": null,
    "usr_id": null,
    "cat_id": null,
    "cal_date": null,
    "cal_additional_detail": null,
    "cal_position": null
};

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

Request   

POST v1/calls

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

act_id   string   

The act_id of an existing record in the account table.

usr_id   string   

The usr_id of an existing record in the user table.

cat_id   integer   

The cat_id of an existing record in the jpcall_type table.

cal_date   string   

Must be a valid date in the format Y:m:d.

cal_additional_detail   string   
cal_time   string  optional  

Must be a valid date in the format H:i.

cal_position   integer   
cal_status   string  optional  
Must be one of:
  • comp
  • no

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/calls/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/calls/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/calls/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the call.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/calls/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"calls\": null,
    \"act_id\": null,
    \"usr_id\": null,
    \"cat_id\": null,
    \"cal_date\": null,
    \"cal_position\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/calls/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "calls": null,
    "act_id": null,
    "usr_id": null,
    "cat_id": null,
    "cal_date": null,
    "cal_position": null
};

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

Request   

PUT v1/calls/{id}

PATCH v1/calls/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the call.

Body Parameters

calls   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

act_id   string   

The act_id of an existing record in the account table.

usr_id   string   

The usr_id of an existing record in the user table.

cat_id   integer   

The cat_id of an existing record in the jpcall_type table.

cal_date   string   

Must be a valid date in the format Y:m:d.

cal_time   string  optional  

Must be a valid date in the format H:i.

cal_position   integer   
cal_status   string  optional  
Must be one of:
  • comp
  • no

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/calls/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/calls/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/calls/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the call.

Campaign-Question-Brands

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/campaign-question-brands" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-question-brands"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/campaign-question-brands

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/campaign-question-brands" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"marketing_campaign_question_id\": null,
    \"brand_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-question-brands"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "marketing_campaign_question_id": null,
    "brand_id": null
};

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

Request   

POST v1/campaign-question-brands

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

marketing_campaign_question_id   integer   

The id of an existing record in the marketing_campaign_question table.

brand_id   integer   

The bnd_id of an existing record in the brand table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/campaign-question-brands/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-question-brands/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/campaign-question-brands/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the campaign question brand.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/campaign-question-brands/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"campaign_question_brands\": null,
    \"marketing_campaign_question_id\": null,
    \"brand_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-question-brands/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "campaign_question_brands": null,
    "marketing_campaign_question_id": null,
    "brand_id": null
};

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

Request   

PUT v1/campaign-question-brands/{id}

PATCH v1/campaign-question-brands/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the campaign question brand.

Body Parameters

campaign_question_brands   string   

Must be between 1 and 11 digits.

marketing_campaign_question_id   integer   

The id of an existing record in the marketing_campaign_question table.

brand_id   integer   

The bnd_id of an existing record in the brand table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/campaign-question-brands/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-question-brands/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/campaign-question-brands/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the campaign question brand.

Campaign-Questions

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/campaign-questions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-questions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/campaign-questions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/campaign-questions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"marketing_campaign_id\": null,
    \"question_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-questions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "marketing_campaign_id": null,
    "question_id": null
};

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

Request   

POST v1/campaign-questions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

marketing_campaign_id   integer   

The id of an existing record in the marketing_campaign table.

question_id   integer   

The id of an existing record in the questions table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/campaign-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/campaign-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the campaign question.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/campaign-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"campaign_questions\": null,
    \"marketing_campaign_id\": null,
    \"question_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "campaign_questions": null,
    "marketing_campaign_id": null,
    "question_id": null
};

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

Request   

PUT v1/campaign-questions/{id}

PATCH v1/campaign-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the campaign question.

Body Parameters

campaign_questions   string   

Must be between 1 and 11 digits.

marketing_campaign_id   integer   

The id of an existing record in the marketing_campaign table.

question_id   integer   

The id of an existing record in the questions table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/campaign-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/campaign-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/campaign-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the campaign question.

Channels

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/channels" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/channels"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/channels

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/channels" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"chn_name\": null,
    \"chn_type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/channels"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "chn_name": null,
    "chn_type": null
};

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

Request   

POST v1/channels

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

chn_name   string   

Must not be greater than 255 characters.

chn_parent_id   string  optional  

Must be between 0 and 11 digits.

chn_type   integer   

Must be at least 0. Must not be greater than 2.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/channels/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/channels/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/channels/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the channel.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/channels/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"channels\": null,
    \"chn_name\": null,
    \"chn_type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/channels/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "channels": null,
    "chn_name": null,
    "chn_type": null
};

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

Request   

PUT v1/channels/{id}

PATCH v1/channels/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the channel.

Body Parameters

channels   string   

Must be between 1 and 11 digits.

chn_name   string   

Must not be greater than 255 characters.

chn_parent_id   string  optional  

Must be between 0 and 11 digits.

chn_type   integer   

Must be at least 0. Must not be greater than 2.

chn_id   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/channels/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/channels/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/channels/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the channel.

Cocktails

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/cocktails" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/cocktails"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/cocktails

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/cocktails" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ckt_name\": null,
    \"bnd_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/cocktails"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ckt_name": null,
    "bnd_id": null
};

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

Request   

POST v1/cocktails

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

ckt_name   string   

Must be between 1 and 255 characters.

ckt_signature   string  optional  
Must be one of:
  • true
  • false
ckt_recipe   string  optional  

Must be between 1 and 255 characters.

ckt_note   string  optional  

Must be between 1 and 255 characters.

act_id   string  optional  

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

bnd_id   integer   

The bnd_id of an existing record in the brand table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/cocktails/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/cocktails/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/cocktails/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the cocktail.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/cocktails/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"cocktails\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/cocktails/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "cocktails": null
};

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

Request   

PUT v1/cocktails/{id}

PATCH v1/cocktails/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the cocktail.

Body Parameters

cocktails   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

ckt_name   string  optional  

Must be between 1 and 255 characters.

ckt_signature   string  optional  
Must be one of:
  • true
  • false
ckt_recipe   string  optional  

Must be between 1 and 255 characters.

ckt_note   string  optional  

Must be between 1 and 255 characters.

act_id   string  optional  

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

bnd_id   integer  optional  

The bnd_id of an existing record in the brand table.

ckt_id   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/cocktails/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/cocktails/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/cocktails/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the cocktail.

Company-Objectives

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/company-objectives" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/company-objectives"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/company-objectives

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/company-objectives" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"sta_name\": null,
    \"cob_name\": null,
    \"cob_start_date\": null,
    \"cob_end_date\": null,
    \"cob_type\": null,
    \"cob_value\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/company-objectives"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "sta_name": null,
    "cob_name": null,
    "cob_start_date": null,
    "cob_end_date": null,
    "cob_type": null,
    "cob_value": null
};

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

Request   

POST v1/company-objectives

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

sta_name   string   

The sta_name of an existing record in the state table.

cob_name   string   

Must not be greater than 255 characters.

cob_start_date   string   

Must be a valid date in the format Y:m:d.

cob_end_date   string   

Must be a valid date in the format Y:m:d.

cob_type   string   
Must be one of:
  • account
  • territory
  • banner
  • state
cob_value   string   

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/company-objectives/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/company-objectives/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/company-objectives/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the company objective.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/company-objectives/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"company_objectives\": null,
    \"sta_name\": null,
    \"cob_name\": null,
    \"cob_start_date\": null,
    \"cob_end_date\": null,
    \"cob_type\": null,
    \"cob_value\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/company-objectives/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "company_objectives": null,
    "sta_name": null,
    "cob_name": null,
    "cob_start_date": null,
    "cob_end_date": null,
    "cob_type": null,
    "cob_value": null
};

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

Request   

PUT v1/company-objectives/{id}

PATCH v1/company-objectives/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the company objective.

Body Parameters

company_objectives   string   

Must be between 1 and 11 digits.

sta_name   string   

The sta_name of an existing record in the state table.

cob_name   string   

Must not be greater than 255 characters.

cob_start_date   string   

Must be a valid date in the format Y:m:d.

cob_end_date   string   

Must be a valid date in the format Y:m:d.

cob_type   string   
Must be one of:
  • account
  • territory
  • banner
  • state
cob_value   string   

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/company-objectives/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/company-objectives/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/company-objectives/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the company objective.

Comply-Answers

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-answers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-answers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-answers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/comply-answers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"response_id\": null,
    \"question_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-answers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "response_id": null,
    "question_id": null
};

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

Request   

POST v1/comply-answers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

response_id   integer   

The id of an existing record in the comply_responses table.

account_id   string  optional  

The act_id of an existing record in the account table.

question_id   integer   

The id of an existing record in the comply_questions table.

answer_text   string  optional  
answer_value   string  optional  

Must not be greater than 255 characters.

option_id   integer  optional  

The id of an existing record in the comply_question_options table.

photo_url   string  optional  

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply answer.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/comply-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"comply_answers\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "comply_answers": null
};

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

Request   

PUT v1/comply-answers/{id}

PATCH v1/comply-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply answer.

Body Parameters

comply_answers   integer   

The id of an existing record in the comply_answers table.

response_id   integer  optional  

The id of an existing record in the comply_responses table.

account_id   string  optional  

The act_id of an existing record in the account table.

question_id   integer  optional  

The id of an existing record in the comply_questions table.

answer_text   string  optional  
answer_value   string  optional  

Must not be greater than 255 characters.

option_id   integer  optional  

The id of an existing record in the comply_question_options table.

photo_url   string  optional  

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/comply-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/comply-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply answer.

Comply-Assignment-Targets

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-assignment-targets" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignment-targets"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-assignment-targets

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/comply-assignment-targets" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"assignment_id\": null,
    \"target_type\": null,
    \"target_value\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignment-targets"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "assignment_id": null,
    "target_type": null,
    "target_value": null
};

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

Request   

POST v1/comply-assignment-targets

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

assignment_id   integer   

The id of an existing record in the comply_assignments table.

target_type   string   

Must not be greater than 255 characters.

target_value   string   

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-assignment-targets/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignment-targets/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-assignment-targets/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply assignment target.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/comply-assignment-targets/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"comply_assignment_targets\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignment-targets/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "comply_assignment_targets": null
};

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

Request   

PUT v1/comply-assignment-targets/{id}

PATCH v1/comply-assignment-targets/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply assignment target.

Body Parameters

comply_assignment_targets   integer   

The id of an existing record in the comply_assignment_targets table.

assignment_id   integer  optional  

The id of an existing record in the comply_assignments table.

target_type   string  optional  

Must not be greater than 255 characters.

target_value   string  optional  

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/comply-assignment-targets/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignment-targets/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/comply-assignment-targets/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply assignment target.

Comply-Assignments

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-assignments" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignments"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-assignments

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/comply-assignments" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null,
    \"start_date\": null,
    \"end_date\": null,
    \"user_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignments"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null,
    "start_date": null,
    "end_date": null,
    "user_id": null
};

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

Request   

POST v1/comply-assignments

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 255 characters.

description   string  optional  
start_date   string   

Must be a valid date.

end_date   string   

Must be a valid date. Must be a date after start_date.

is_active   boolean  optional  
calls_only   boolean  optional  
re_occuring   boolean  optional  
lock_on_completion   boolean  optional  
user_id   string   

The usr_id of an existing record in the user table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-assignments/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignments/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-assignments/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply assignment.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/comply-assignments/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"comply_assignments\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignments/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "comply_assignments": null
};

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

Request   

PUT v1/comply-assignments/{id}

PATCH v1/comply-assignments/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply assignment.

Body Parameters

comply_assignments   integer   

The id of an existing record in the comply_assignments table.

name   string  optional  

Must not be greater than 255 characters.

description   string  optional  
start_date   string  optional  

Must be a valid date.

end_date   string  optional  

Must be a valid date. Must be a date after start_date.

is_active   boolean  optional  
calls_only   boolean  optional  
re_occuring   boolean  optional  
lock_on_completion   boolean  optional  
user_id   string  optional  

The usr_id of an existing record in the user table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/comply-assignments/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-assignments/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/comply-assignments/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply assignment.

Comply-Question-Options

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-question-options" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-question-options"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-question-options

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/comply-question-options" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"question_id\": null,
    \"option_text\": null,
    \"value\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-question-options"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "question_id": null,
    "option_text": null,
    "value": null
};

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

Request   

POST v1/comply-question-options

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

question_id   integer   

The id of an existing record in the comply_questions table.

option_text   string   

Must not be greater than 255 characters.

value   string   

Must not be greater than 255 characters.

order   integer  optional  
is_positive   boolean  optional  
trigger_action   string  optional  

Must not be greater than 255 characters.

trigger_next_question_id   integer  optional  

The id of an existing record in the comply_questions table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-question-options/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-question-options/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-question-options/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply question option.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/comply-question-options/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"comply_question_options\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-question-options/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "comply_question_options": null
};

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

Request   

PUT v1/comply-question-options/{id}

PATCH v1/comply-question-options/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply question option.

Body Parameters

comply_question_options   integer   

The id of an existing record in the comply_question_options table.

question_id   integer  optional  

The id of an existing record in the comply_questions table.

option_text   string  optional  

Must not be greater than 255 characters.

value   string  optional  

Must not be greater than 255 characters.

order   integer  optional  
is_positive   boolean  optional  
trigger_action   string  optional  

Must not be greater than 255 characters.

trigger_next_question_id   integer  optional  

The id of an existing record in the comply_questions table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/comply-question-options/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-question-options/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/comply-question-options/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply question option.

Comply-Questions

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-questions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-questions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-questions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/comply-questions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"assignment_id\": null,
    \"question_text\": null,
    \"question_type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-questions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "assignment_id": null,
    "question_text": null,
    "question_type": null
};

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

Request   

POST v1/comply-questions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

assignment_id   integer   

The id of an existing record in the comply_assignments table.

question_text   string   
question_type   string   

Must not be greater than 255 characters.

is_required   boolean  optional  
order   integer  optional  
example_photo_url   string  optional  
product_id   integer  optional  

The pro_id of an existing record in the product table.

parent_question_id   integer  optional  

The id of an existing record in the comply_questions table.

trigger_value   string  optional  

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply question.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/comply-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"comply_questions\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "comply_questions": null
};

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

Request   

PUT v1/comply-questions/{id}

PATCH v1/comply-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply question.

Body Parameters

comply_questions   integer   

The id of an existing record in the comply_questions table.

assignment_id   integer  optional  

The id of an existing record in the comply_assignments table.

question_text   string  optional  
question_type   string  optional  

Must not be greater than 255 characters.

is_required   boolean  optional  
order   integer  optional  
example_photo_url   string  optional  
product_id   integer  optional  

The pro_id of an existing record in the product table.

parent_question_id   integer  optional  

The id of an existing record in the comply_questions table.

trigger_value   string  optional  

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/comply-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/comply-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply question.

Comply-Responses

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-responses" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-responses"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-responses

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/comply-responses" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"assignment_id\": null,
    \"user_id\": null,
    \"account_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-responses"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "assignment_id": null,
    "user_id": null,
    "account_id": null
};

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

Request   

POST v1/comply-responses

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

assignment_id   integer   

The id of an existing record in the comply_assignments table.

user_id   string   

The usr_id of an existing record in the user table.

account_id   string   

The act_id of an existing record in the account table.

started_at   string  optional  

Must be a valid date.

completed_at   string  optional  

Must be a valid date. Must be a date after started_at.

latitude   number  optional  
longitude   number  optional  
gps_accuracy   string  optional  

Must not be greater than 255 characters.

general_comment   string  optional  

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/comply-responses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-responses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/comply-responses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply response.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/comply-responses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"comply_responses\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/comply-responses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "comply_responses": null
};

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

Request   

PUT v1/comply-responses/{id}

PATCH v1/comply-responses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply response.

Body Parameters

comply_responses   integer   

The id of an existing record in the comply_responses table.

assignment_id   integer  optional  

The id of an existing record in the comply_assignments table.

user_id   string  optional  

The usr_id of an existing record in the user table.

account_id   string  optional  

The act_id of an existing record in the account table.

started_at   string  optional  

Must be a valid date.

completed_at   string  optional  

Must be a valid date. Must be a date after started_at.

latitude   number  optional  
longitude   number  optional  
gps_accuracy   string  optional  

Must not be greater than 255 characters.

general_comment   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/comply-responses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/comply-responses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/comply-responses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the comply response.

Cycles

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/cycles" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/cycles"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/cycles

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/cycles" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null,
    \"weeks\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/cycles"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null,
    "weeks": null
};

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

Request   

POST v1/cycles

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 255 characters.

weeks   number   

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/cycles/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/cycles/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/cycles/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the cycle.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/cycles/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"cycles\": null,
    \"name\": null,
    \"weeks\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/cycles/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "cycles": null,
    "name": null,
    "weeks": null
};

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

Request   

PUT v1/cycles/{id}

PATCH v1/cycles/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the cycle.

Body Parameters

cycles   string   

Must be between 1 and 11 digits.

name   string   

Must not be greater than 255 characters.

weeks   number   

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/cycles/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/cycles/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/cycles/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the cycle.

Data-Source-Types

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/data-source-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/data-source-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/data-source-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/data-source-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/data-source-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null
};

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

Request   

POST v1/data-source-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 25 characters.

description   string  optional  

Must not be greater than 500 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/data-source-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/data-source-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/data-source-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the data source type.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/data-source-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"data_source_types\": null,
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/data-source-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "data_source_types": null,
    "name": null
};

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

Request   

PUT v1/data-source-types/{id}

PATCH v1/data-source-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the data source type.

Body Parameters

data_source_types   string   

Must be between 1 and 11 digits.

name   string   

Must not be greater than 25 characters.

description   string  optional  

Must not be greater than 500 characters.

Distribution-Packaged-Audits

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/distribution-packaged-audits" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packaged-audits"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/distribution-packaged-audits

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/distribution-packaged-audits" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"dipa_start_date\": null,
    \"dipa_end_date\": null,
    \"dip_id\": null,
    \"dip_value\": null,
    \"pro_id\": null,
    \"sea_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packaged-audits"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "dipa_start_date": null,
    "dipa_end_date": null,
    "dip_id": null,
    "dip_value": null,
    "pro_id": null,
    "sea_id": null
};

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

Request   

POST v1/distribution-packaged-audits

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

dipa_start_date   string   

Must be a valid date in the format "Y-m-d H:i:s".

dipa_end_date   string   

Must be a valid date in the format "Y-m-d H:i:s".

dip_id   string   

The dip_id of an existing record in the distribution_packaged table.

dip_value   string   
Must be one of:
  • true
pro_id   integer   

The pro_id of an existing record in the product table.

sea_id   string   

The sea_id of an existing record in the selling_area table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/distribution-packaged-audits/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packaged-audits/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/distribution-packaged-audits/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the distribution packaged audit.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/distribution-packaged-audits/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"distribution_packaged_audits\": null,
    \"dip_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packaged-audits/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "distribution_packaged_audits": null,
    "dip_id": null
};

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

Request   

PUT v1/distribution-packaged-audits/{id}

PATCH v1/distribution-packaged-audits/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the distribution packaged audit.

Body Parameters

distribution_packaged_audits   string   

Must be between 1 and 11 digits.

dipa_start_date   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

dipa_end_date   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

dip_id   string   

The dip_id of an existing record in the distribution_packaged table.

dip_value   string  optional  
Must be one of:
  • true
pro_id   integer  optional  

The pro_id of an existing record in the product table.

sea_id   string  optional  

The sea_id of an existing record in the selling_area table.

dipa_id   string  optional  

Distribution-Packages

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/distribution-packages" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packages"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/distribution-packages

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/distribution-packages" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"dip_value\": null,
    \"pro_id\": null,
    \"sea_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packages"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "dip_value": null,
    "pro_id": null,
    "sea_id": null
};

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

Request   

POST v1/distribution-packages

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

dip_value   string   
Must be one of:
  • true
pro_id   integer   

The pro_id of an existing record in the product table.

sea_id   string   

The sea_id of an existing record in the selling_area table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/distribution-packages/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packages/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/distribution-packages/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the distribution package.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/distribution-packages/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"distribution_packages\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packages/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "distribution_packages": null
};

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

Request   

PUT v1/distribution-packages/{id}

PATCH v1/distribution-packages/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the distribution package.

Body Parameters

distribution_packages   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

dip_value   string  optional  
Must be one of:
  • true
pro_id   integer  optional  

The pro_id of an existing record in the product table.

sea_id   string  optional  

The sea_id of an existing record in the selling_area table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/distribution-packages/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/distribution-packages/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/distribution-packages/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the distribution package.

Gps

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/gps" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/gps"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/gps

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/gps" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"gps_latitude\": null,
    \"gps_longitude\": null,
    \"gps_time\": null,
    \"usr_id\": null,
    \"cal_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/gps"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "gps_latitude": null,
    "gps_longitude": null,
    "gps_time": null,
    "usr_id": null,
    "cal_id": null
};

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

Request   

POST v1/gps

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

gps_latitude   number   
gps_longitude   number   
gps_time   string   

Must be a valid date in the format "Y-m-d H:i:s".

usr_id   string   

The usr_id of an existing record in the user table.

cal_id   string   

The cal_id of an existing record in the jpcall table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/gps/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/gps/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/gps/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the gp.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/gps/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"gps\": null,
    \"gps_latitude\": null,
    \"gps_longitude\": null,
    \"gps_time\": null,
    \"usr_id\": null,
    \"cal_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/gps/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "gps": null,
    "gps_latitude": null,
    "gps_longitude": null,
    "gps_time": null,
    "usr_id": null,
    "cal_id": null
};

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

Request   

PUT v1/gps/{id}

PATCH v1/gps/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the gp.

Body Parameters

gps   string   

Must be between 1 and 11 digits.

gps_latitude   number   
gps_longitude   number   
gps_time   string   

Must be a valid date in the format "Y-m-d H:i:s".

usr_id   string   

The usr_id of an existing record in the user table.

cal_id   string   

The cal_id of an existing record in the jpcall table.

gps_accuracy   number  optional  
gps_id   string  optional  

Grades

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/grades" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/grades"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/grades

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/grades" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"gra_id\": null,
    \"gra_standard_cycle\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/grades"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "gra_id": null,
    "gra_standard_cycle": null
};

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

Request   

POST v1/grades

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

gra_id   string   

Must not be greater than 20 characters.

gra_standard_cycle   integer   

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/grades/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/grades/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/grades/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the grade.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/grades/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"grades\": null,
    \"gra_standard_cycle\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/grades/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "grades": null,
    "gra_standard_cycle": null
};

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

Request   

PUT v1/grades/{id}

PATCH v1/grades/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the grade.

Body Parameters

grades   string   

Must not be greater than 20 characters.

gra_standard_cycle   integer   

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/grades/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/grades/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/grades/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the grade.

Groups

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/groups" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/groups"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/groups

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/groups" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/groups"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null
};

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

Request   

POST v1/groups

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 45 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/groups/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/groups/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/groups/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the group.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/groups/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"groups\": null,
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/groups/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "groups": null,
    "name": null
};

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

Request   

PUT v1/groups/{id}

PATCH v1/groups/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the group.

Body Parameters

groups   string   

Must be between 1 and 11 digits.

name   string   

Must not be greater than 45 characters.

Marketing-Activities

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/marketing-activities" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-activities"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/marketing-activities

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/marketing-activities" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"account_id\": null,
    \"brand_id\": null,
    \"marketing_campaign_id\": null,
    \"marketing_status_id\": null,
    \"start_date\": null,
    \"end_date\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-activities"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "account_id": null,
    "brand_id": null,
    "marketing_campaign_id": null,
    "marketing_status_id": null,
    "start_date": null,
    "end_date": null
};

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

Request   

POST v1/marketing-activities

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

account_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

brand_id   integer   

The bnd_id of an existing record in the brand table.

marketing_campaign_id   integer   

The id of an existing record in the marketing_campaign table.

marketing_status_id   integer   

The id of an existing record in the marketing_status table.

start_date   string   

Must be a valid date in the format Y-m-d H:i:s.

end_date   string   

Must be a valid date in the format Y-m-d H:i:s.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/marketing-activities/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-activities/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/marketing-activities/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the marketing activity.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/marketing-activities/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"marketing-activities\": null,
    \"account_id\": null,
    \"brand_id\": null,
    \"usr_id\": null,
    \"marketing_campaign_id\": null,
    \"marketing_status_id\": null,
    \"start_date\": null,
    \"end_date\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-activities/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "marketing-activities": null,
    "account_id": null,
    "brand_id": null,
    "usr_id": null,
    "marketing_campaign_id": null,
    "marketing_status_id": null,
    "start_date": null,
    "end_date": null
};

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

Request   

PUT v1/marketing-activities/{id}

PATCH v1/marketing-activities/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the marketing activity.

Body Parameters

marketing-activities   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

account_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

brand_id   integer   

The bnd_id of an existing record in the brand table.

usr_id   string   

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

marketing_campaign_id   integer   

The id of an existing record in the marketing_campaign table.

marketing_status_id   integer   

The id of an existing record in the marketing_status table.

start_date   string   

Must be a valid date in the format Y-m-d H:i:s.

end_date   string   

Must be a valid date in the format Y-m-d H:i:s.

Marketing-Campaigns

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/marketing-campaigns" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-campaigns"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/marketing-campaigns

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/marketing-campaigns" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null,
    \"value\": null,
    \"brand_id\": null,
    \"active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-campaigns"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null,
    "value": null,
    "brand_id": null,
    "active": null
};

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

Request   

POST v1/marketing-campaigns

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 255 characters.

value   string   

Must not be greater than 255 characters.

brand_id   integer   

The bnd_id of an existing record in the brand table.

active   string   
Must be one of:
  • 1
  • 0

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/marketing-campaigns/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-campaigns/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/marketing-campaigns/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the marketing campaign.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/marketing-campaigns/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"marketing-campaigns\": null,
    \"user_id\": null,
    \"name\": null,
    \"brand_id\": null,
    \"active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-campaigns/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "marketing-campaigns": null,
    "user_id": null,
    "name": null,
    "brand_id": null,
    "active": null
};

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

Request   

PUT v1/marketing-campaigns/{id}

PATCH v1/marketing-campaigns/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the marketing campaign.

Body Parameters

marketing-campaigns   string   

Must be between 1 and 11 digits.

user_id   string   

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

name   string   

Must not be greater than 255 characters.

brand_id   integer   

The bnd_id of an existing record in the brand table.

active   string   
Must be one of:
  • 1
  • 0

Marketing-Statuses

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/marketing-statuses" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-statuses"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/marketing-statuses

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/marketing-statuses" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-statuses"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null
};

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

Request   

POST v1/marketing-statuses

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/marketing-statuses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-statuses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/marketing-statuses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the marketing status.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/marketing-statuses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-statuses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null
};

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

Request   

PUT v1/marketing-statuses/{id}

PATCH v1/marketing-statuses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the marketing status.

Body Parameters

name   string   

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/marketing-statuses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/marketing-statuses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/marketing-statuses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the marketing status.

Modules

Modules are specifically used for the Android app only. Please use the Admin-Modules resource for the web version.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/modules" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/modules"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/modules

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the module.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"modules\": null,
    \"mod_activated\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "modules": null,
    "mod_activated": null
};

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

Request   

PUT v1/modules/{id}

PATCH v1/modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the module.

Body Parameters

modules   string   

Must be between 1 and 11 digits.

mod_activated   string   
Must be one of:
  • TRUE
  • FALSE

On-Trade-Segmentations

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/on-trade-segmentations" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentations"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/on-trade-segmentations

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/on-trade-segmentations" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ots_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentations"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ots_name": null
};

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

Request   

POST v1/on-trade-segmentations

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

ots_name   string   

Must not be greater than 45 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/on-trade-segmentations/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentations/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/on-trade-segmentations/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the on trade segmentation.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/on-trade-segmentations/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ots_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentations/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ots_name": null
};

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

Request   

PUT v1/on-trade-segmentations/{id}

PATCH v1/on-trade-segmentations/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the on trade segmentation.

Body Parameters

ots_name   string   

Must not be greater than 45 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/on-trade-segmentations/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentations/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/on-trade-segmentations/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the on trade segmentation.

On-Trade-Segmentations-Product

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/on-trade-segmentation-products" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentation-products"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/on-trade-segmentation-products

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/on-trade-segmentation-products" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ots_id\": null,
    \"pro_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentation-products"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ots_id": null,
    "pro_id": null
};

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

Request   

POST v1/on-trade-segmentation-products

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

ots_id   integer   

The ots_id of an existing record in the on_trade_segmentation table.

pro_id   integer   

The pro_id of an existing record in the product table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/on-trade-segmentation-products/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentation-products/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/on-trade-segmentation-products/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the on trade segmentation product.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/on-trade-segmentation-products/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"on_trade_segmentation_products\": null,
    \"ots_id\": null,
    \"pro_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentation-products/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "on_trade_segmentation_products": null,
    "ots_id": null,
    "pro_id": null
};

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

Request   

PUT v1/on-trade-segmentation-products/{id}

PATCH v1/on-trade-segmentation-products/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the on trade segmentation product.

Body Parameters

on_trade_segmentation_products   string   

Must be between 1 and 11 digits.

ots_id   integer   

The ots_id of an existing record in the on_trade_segmentation table.

pro_id   integer   

The pro_id of an existing record in the product table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/on-trade-segmentation-products/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/on-trade-segmentation-products/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/on-trade-segmentation-products/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the on trade segmentation product.

Order-Histories

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/order-histories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/order-histories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/order-histories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/order-histories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"odh_quantity\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/order-histories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "odh_quantity": null
};

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

Request   

POST v1/order-histories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

odh_quantity   integer   
odh_type   string  optional  

Must not be greater than 45 characters.

odh_expiration   string  optional  

Must not be greater than 10 characters.

act_id   string  optional  

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

pro_id   integer  optional  

The pro_id of an existing record in the product table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/order-histories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/order-histories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/order-histories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the order history.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/order-histories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"order_histories\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/order-histories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "order_histories": null
};

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

Request   

PUT v1/order-histories/{id}

PATCH v1/order-histories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the order history.

Body Parameters

order_histories   string   

Must be between 1 and 11 digits.

odh_quantity   integer  optional  
odh_type   string  optional  

Must not be greater than 45 characters.

odh_expiration   string  optional  

Must not be greater than 10 characters.

act_id   string  optional  

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

pro_id   integer  optional  

The pro_id of an existing record in the product table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/order-histories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/order-histories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/order-histories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the order history.

Ownership Groups

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/ownership-groups" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/ownership-groups"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/ownership-groups

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/ownership-groups" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"osg_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/ownership-groups"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "osg_name": null
};

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

Request   

POST v1/ownership-groups

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

osg_name   string   

Must not be greater than 50 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/ownership-groups/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/ownership-groups/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/ownership-groups/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the ownership group.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/ownership-groups/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"ownership_groups\": null,
    \"osg_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/ownership-groups/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "ownership_groups": null,
    "osg_name": null
};

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

Request   

PUT v1/ownership-groups/{id}

PATCH v1/ownership-groups/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the ownership group.

Body Parameters

ownership_groups   string   

Must be between 1 and 11 digits.

osg_name   string   

Must not be greater than 50 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/ownership-groups/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/ownership-groups/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/ownership-groups/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the ownership group.

Perfect-Answers

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/perfect-answers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-answers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/perfect-answers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/perfect-answers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"perfect_question_id\": null,
    \"account_id\": null,
    \"answer\": null,
    \"usr_id\": null,
    \"points\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-answers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "perfect_question_id": null,
    "account_id": null,
    "answer": null,
    "usr_id": null,
    "points": null
};

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

Request   

POST v1/perfect-answers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

perfect_question_id   integer   

The id of an existing record in the perfect_question table.

account_id   string   

The act_id of an existing record in the account table. Must not be greater than 36 characters.

answer   string   
Must be one of:
  • 0
  • 1
product_id   integer  optional  

The pro_id of an existing record in the product table.

usr_id   string   

The usr_id of an existing record in the user table. Must not be greater than 36 characters.

points   integer   

Must be at least 0.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/perfect-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/perfect-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect answer.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/perfect-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"perfect_answers\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "perfect_answers": null
};

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

Request   

PUT v1/perfect-answers/{id}

PATCH v1/perfect-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect answer.

Body Parameters

perfect_answers   string   

Must be between 1 and 11 digits.

perfect_question_id   integer  optional  

The id of an existing record in the perfect_question table.

account_id   string  optional  

The act_id of an existing record in the account table. Must not be greater than 36 characters.

answer   string  optional  
Must be one of:
  • 0
  • 1
product_id   integer  optional  

The pro_id of an existing record in the product table.

usr_id   string  optional  

The usr_id of an existing record in the user table. Must not be greater than 36 characters.

points   integer  optional  

Must be at least 0.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/perfect-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/perfect-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect answer.

Perfect-Categories

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/perfect-categories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-categories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/perfect-categories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/perfect-categories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"category\": null,
    \"account_type\": null,
    \"order\": null,
    \"visible\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-categories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "category": null,
    "account_type": null,
    "order": null,
    "visible": null
};

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

Request   

POST v1/perfect-categories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

category   string   

Must not be greater than 500 characters.

account_type   integer   
Must be one of:
  • 1
  • 2
parent_perfect_category_id   integer  optional  

The id of an existing record in the perfect_category table.

order   integer   

Must be at least 1.

visible   integer   
Must be one of:
  • 1
  • 0

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/perfect-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/perfect-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect category.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/perfect-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"perfect_categories\": null,
    \"category\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "perfect_categories": null,
    "category": null
};

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

Request   

PUT v1/perfect-categories/{id}

PATCH v1/perfect-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect category.

Body Parameters

perfect_categories   string   

Must be between 1 and 11 digits.

category   string   

Must not be greater than 500 characters.

account_type   integer  optional  
Must be one of:
  • 1
  • 2
parent_perfect_category_id   integer  optional  

The id of an existing record in the perfect_category table.

order   integer  optional  

Must be at least 1.

visible   string  optional  
Must be one of:
  • 0
  • 1

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/perfect-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/perfect-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect category.

Perfect-Questions

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/perfect-questions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-questions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/perfect-questions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/perfect-questions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"question\": null,
    \"perfect_category_id\": null,
    \"order\": null,
    \"points\": null,
    \"multiple_answers_allowed\": null,
    \"product_selection_allowed\": null,
    \"visible\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-questions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "question": null,
    "perfect_category_id": null,
    "order": null,
    "points": null,
    "multiple_answers_allowed": null,
    "product_selection_allowed": null,
    "visible": null
};

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

Request   

POST v1/perfect-questions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

question   string   

Must not be greater than 500 characters.

perfect_category_id   integer   

The id of an existing record in the perfect_category table.

order   integer   

Must be at least 1.

points   integer   

Must be at least 0.

product_id   integer  optional  

The pro_id of an existing record in the product table.

multiple_answers_allowed   string   
Must be one of:
  • 0
  • 1
product_selection_allowed   string   
Must be one of:
  • 0
  • 1
visible   string   
Must be one of:
  • 0
  • 1

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/perfect-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/perfect-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect question.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/perfect-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"perfect_questions\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "perfect_questions": null
};

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

Request   

PUT v1/perfect-questions/{id}

PATCH v1/perfect-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect question.

Body Parameters

perfect_questions   string   

Must be between 1 and 11 digits.

question   string  optional  

Must not be greater than 500 characters.

perfect_category_id   integer  optional  

The id of an existing record in the perfect_category table.

order   integer  optional  

Must be at least 1.

points   integer  optional  

Must be at least 0.

product_id   integer  optional  

The pro_id of an existing record in the product table.

multiple_answers_allowed   string  optional  
Must be one of:
  • 0
  • 1
product_selection_allowed   string  optional  
Must be one of:
  • 0
  • 1
visible   string  optional  
Must be one of:
  • 0
  • 1

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/perfect-questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/perfect-questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect question.

Perfect-Responses

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/perfect-responses" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-responses"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/perfect-responses

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/perfect-responses" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"act_id\": null,
    \"saved_date\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-responses"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "act_id": null,
    "saved_date": null
};

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

Request   

POST v1/perfect-responses

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

act_id   string   

The act_id of an existing record in the account table. Must not be greater than 36 characters.

cal_id   string  optional  

The cal_id of an existing record in the jpcall table. Must not be greater than 36 characters.

saved_date   string   

Must be a valid date.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/perfect-responses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-responses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/perfect-responses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect response.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/perfect-responses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"perfect_responses\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-responses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "perfect_responses": null
};

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

Request   

PUT v1/perfect-responses/{id}

PATCH v1/perfect-responses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect response.

Body Parameters

perfect_responses   string   

Must be between 1 and 11 digits.

act_id   string  optional  

The act_id of an existing record in the account table. Must not be greater than 36 characters.

cal_id   string  optional  

The cal_id of an existing record in the jpcall table. Must not be greater than 36 characters.

saved_date   string  optional  

Must be a valid date.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/perfect-responses/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/perfect-responses/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/perfect-responses/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the perfect response.

Price-Types

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/price-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/price-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/price-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/price-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"pct_name\": null,
    \"pct_order\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/price-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "pct_name": null,
    "pct_order": null
};

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

Request   

POST v1/price-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

pct_name   string   

Must not be greater than 255 characters.

pct_order   integer   

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/price-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/price-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/price-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the price type.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/price-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"price_types\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/price-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "price_types": null
};

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

Request   

PUT v1/price-types/{id}

PATCH v1/price-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the price type.

Body Parameters

price_types   string   

Must be between 1 and 11 digits.

pct_name   string  optional  

Must not be greater than 255 characters.

pct_order   integer  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/price-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/price-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/price-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the price type.

Product-Pricings

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/product-pricings" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/product-pricings"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/product-pricings

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/product-pricings" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"prp_price\": null,
    \"pro_id\": null,
    \"pct_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/product-pricings"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "prp_price": null,
    "pro_id": null,
    "pct_id": null
};

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

Request   

POST v1/product-pricings

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

prp_price   number   
pro_id   integer   

The pro_id of an existing record in the product table.

pct_id   integer   

The pct_id of an existing record in the price_type table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/product-pricings/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/product-pricings/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/product-pricings/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the product pricing.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/product-pricings/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"product_pricings\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/product-pricings/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "product_pricings": null
};

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

Request   

PUT v1/product-pricings/{id}

PATCH v1/product-pricings/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the product pricing.

Body Parameters

product_pricings   string   

Must be between 1 and 11 digits.

prp_price   number  optional  
pro_id   integer  optional  

The pro_id of an existing record in the product table.

pct_id   integer  optional  

The pct_id of an existing record in the price_type table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/product-pricings/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/product-pricings/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/product-pricings/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the product pricing.

Product-States

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/product-states" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/product-states"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/product-states

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/product-states" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"pro_id\": null,
    \"sta_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/product-states"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "pro_id": null,
    "sta_name": null
};

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

Request   

POST v1/product-states

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

pro_id   string   

Must be between 1 and 11 digits. The pro_id of an existing record in the product table.

sta_name   string   

The sta_name of an existing record in the state table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/product-states/product//state/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/product-states/product//state/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/product-states/product/{product}/state/{state}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

product   string   

The product.

state   string   

The state.

Retrieve by product

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/product-states/product/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/product-states/product/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/product-states/product/{product}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

product   string   

The product.

Retrieve by state

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/product-states/state/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/product-states/state/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/product-states/state/{state}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

state   string   

The state.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/product-states/product//state/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"pro_id\": null,
    \"sta_name\": null,
    \"stock\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/product-states/product//state/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "pro_id": null,
    "sta_name": null,
    "stock": null
};

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

Request   

PUT v1/product-states/product/{product}/state/{state}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

product   string   

The product.

state   string   

The state.

Body Parameters

pro_id   string   

Must be between 1 and 11 digits. The pro_id of an existing record in the product table.

sta_name   string   

The sta_name of an existing record in the state table.

stock   integer   

Must be at least 0.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/product-states/product//state/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/product-states/product//state/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/product-states/product/{product}/state/{state}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

product   string   

The product.

state   string   

The state.

Product-Unit-Of-Measures

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/product-unit-of-measures" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/product-unit-of-measures"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/product-unit-of-measures

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/product-unit-of-measures" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/product-unit-of-measures"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null
};

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

Request   

POST v1/product-unit-of-measures

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 20 characters.

description   string  optional  

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/product-unit-of-measures/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/product-unit-of-measures/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/product-unit-of-measures/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the product unit of measure.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/product-unit-of-measures/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/product-unit-of-measures/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null
};

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

Request   

PUT v1/product-unit-of-measures/{id}

PATCH v1/product-unit-of-measures/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the product unit of measure.

Body Parameters

name   string   

Must not be greater than 20 characters.

description   string  optional  

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/product-unit-of-measures/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/product-unit-of-measures/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/product-unit-of-measures/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the product unit of measure.

Products

Update multiple

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/products" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"upsert\": null,
    \"product\": [
        {
            \"pro_id\": null,
            \"pro_description\": null,
            \"pro_short_name\": null,
            \"pro_simtac\": null,
            \"bnd_id\": null,
            \"siz_name\": null,
            \"tap_id\": null,
            \"tac_id\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/products"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "upsert": null,
    "product": [
        {
            "pro_id": null,
            "pro_description": null,
            "pro_short_name": null,
            "pro_simtac": null,
            "bnd_id": null,
            "siz_name": null,
            "tap_id": null,
            "tac_id": null
        }
    ]
};

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

Request   

PUT v1/products

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

upsert   string   
Must be one of:
  • 1
  • 0
product   object[]   

Must have at least 1 items. Must not have more than 50 items.
pro_id   string   

The pro_id of an existing record in the product table.

pro_description   string   

Must not be greater than 50 characters.

pro_short_name   string   

Must not be greater than 100 characters.

pro_order_value   string  optional  

Must not be greater than 255 characters.

pro_order   integer  optional  
pro_additional_information_1   string  optional  

Must not be greater than 255 characters.

pro_additional_information_2   string  optional  

Must not be greater than 255 characters.

pro_additional_information_3   string  optional  

Must not be greater than 255 characters.

pro_additional_information_4   string  optional  

Must not be greater than 255 characters.

pro_additional_information_5   string  optional  

Must not be greater than 255 characters.

pro_additional_information_6   string  optional  

Must not be greater than 255 characters.

pro_additional_information_7   string  optional  

Must not be greater than 255 characters.

pro_additional_information_8   string  optional  

Must not be greater than 255 characters.

pro_additional_information_9   string  optional  

Must not be greater than 255 characters.

pro_additional_information_10   string  optional  

Must not be greater than 255 characters.

pro_simtac   string   
Must be one of:
  • true
  • false
bnd_id   integer   

The bnd_id of an existing record in the brand table.

siz_name   string   

The siz_name of an existing record in the size table.

tap_id   integer   

The tap_id of an existing record in the tap table.

tac_id   integer   

The tac_id of an existing record in the tap_category table.

is_active   string  optional  
Must be one of:
  • 1
  • 0

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/products" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/products"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/products

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/products" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"pro_description\": null,
    \"pro_short_name\": null,
    \"pro_simtac\": null,
    \"bnd_id\": null,
    \"siz_name\": null,
    \"tap_id\": null,
    \"tac_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/products"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "pro_description": null,
    "pro_short_name": null,
    "pro_simtac": null,
    "bnd_id": null,
    "siz_name": null,
    "tap_id": null,
    "tac_id": null
};

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

Request   

POST v1/products

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

pro_description   string   

Must not be greater than 50 characters.

pro_short_name   string   

Must not be greater than 100 characters.

pro_order_value   string  optional  

Must not be greater than 255 characters.

pro_order   integer  optional  
pro_additional_information_1   string  optional  

Must not be greater than 255 characters.

pro_additional_information_2   string  optional  

Must not be greater than 255 characters.

pro_additional_information_3   string  optional  

Must not be greater than 255 characters.

pro_additional_information_4   string  optional  

Must not be greater than 255 characters.

pro_additional_information_5   string  optional  

Must not be greater than 255 characters.

pro_additional_information_6   string  optional  

Must not be greater than 255 characters.

pro_additional_information_7   string  optional  

Must not be greater than 255 characters.

pro_additional_information_8   string  optional  

Must not be greater than 255 characters.

pro_additional_information_9   string  optional  

Must not be greater than 255 characters.

pro_additional_information_10   string  optional  

Must not be greater than 255 characters.

pro_simtac   string   
Must be one of:
  • true
  • false
bnd_id   integer   

The bnd_id of an existing record in the brand table.

siz_name   string   

The siz_name of an existing record in the size table.

tap_id   integer   

The tap_id of an existing record in the tap table.

tac_id   integer   

The tac_id of an existing record in the tap_category table.

is_active   string  optional  
Must be one of:
  • 1
  • 0

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/products/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/products/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/products/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the product.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/products/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"products\": null,
    \"bnd_id\": null,
    \"siz_name\": null,
    \"tap_id\": null,
    \"tac_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/products/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "products": null,
    "bnd_id": null,
    "siz_name": null,
    "tap_id": null,
    "tac_id": null
};

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

Request   

PUT v1/products/{id}

PATCH v1/products/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the product.

Body Parameters

products   string   

Must be between 1 and 11 digits.

pro_description   string  optional  

Must not be greater than 50 characters.

pro_short_name   string  optional  

Must not be greater than 100 characters.

pro_order_value   string  optional  

Must not be greater than 255 characters.

pro_order   integer  optional  
pro_additional_information_1   string  optional  

Must not be greater than 255 characters.

pro_additional_information_2   string  optional  

Must not be greater than 255 characters.

pro_additional_information_3   string  optional  

Must not be greater than 255 characters.

pro_additional_information_4   string  optional  

Must not be greater than 255 characters.

pro_additional_information_5   string  optional  

Must not be greater than 255 characters.

pro_additional_information_6   string  optional  

Must not be greater than 255 characters.

pro_additional_information_7   string  optional  

Must not be greater than 255 characters.

pro_additional_information_8   string  optional  

Must not be greater than 255 characters.

pro_additional_information_9   string  optional  

Must not be greater than 255 characters.

pro_additional_information_10   string  optional  

Must not be greater than 255 characters.

pro_simtac   string  optional  
Must be one of:
  • true
  • false
bnd_id   integer   

The bnd_id of an existing record in the brand table.

siz_name   string   

The siz_name of an existing record in the size table.

tap_id   integer   

The tap_id of an existing record in the tap table.

tac_id   integer   

The tac_id of an existing record in the tap_category table.

is_active   string  optional  
Must be one of:
  • 1
  • 0

Promo

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promo" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/promo"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promo

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/promo" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"prm_id\": null,
    \"act_id\": null,
    \"bnd_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promo"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "prm_id": null,
    "act_id": null,
    "bnd_id": null
};

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

Request   

POST v1/promo

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

prm_id   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

prm_start_date   string  optional  

Must not be greater than 255 characters.

prm_end_date   string  optional  

Must not be greater than 255 characters.

prm_type   string  optional  

Must contain only letters, numbers, dashes and underscores. The bnd_id of an existing record in the brand table. Must be between 1 and 36 characters.

prm_note   string  optional  

Must not be greater than 255 characters.

act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

bnd_id   string   

Must contain only letters, numbers, dashes and underscores. The bnd_id of an existing record in the brand table. Must be between 1 and 36 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promo/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promo/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promo/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promo.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/promo/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"prm_id\": null,
    \"act_id\": null,
    \"bnd_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promo/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "prm_id": null,
    "act_id": null,
    "bnd_id": null
};

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

Request   

PUT v1/promo/{id}

PATCH v1/promo/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promo.

Body Parameters

prm_id   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

prm_start_date   string  optional  

Must not be greater than 255 characters.

prm_end_date   string  optional  

Must not be greater than 255 characters.

prm_type   string  optional  

Must contain only letters, numbers, dashes and underscores. The bnd_id of an existing record in the brand table. Must be between 1 and 36 characters.

prm_note   string  optional  

Must not be greater than 255 characters.

act_id   string   

Must contain only letters, numbers, dashes and underscores. The act_id of an existing record in the account table. Must be between 1 and 36 characters.

bnd_id   string   

Must contain only letters, numbers, dashes and underscores. The bnd_id of an existing record in the brand table. Must be between 1 and 36 characters.

usr_id   string  optional  

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

Promo-Photos

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promo-photos" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/promo-photos"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promo-photos

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/promo-photos" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"prm_id\": null,
    \"usr_id\": null,
    \"url\": null,
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promo-photos"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "prm_id": null,
    "usr_id": null,
    "url": null,
    "name": null
};

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

Request   

POST v1/promo-photos

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

prm_id   string   

Must contain only letters, numbers, dashes and underscores. The prm_id of an existing record in the promo table. Must be between 1 and 36 characters.

usr_id   string   

The usr_id of an existing record in the user table.

url   string   
name   string   

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promo-photos/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promo-photos/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promo-photos/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promo photo.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/promo-photos/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"prm_id\": null,
    \"usr_id\": null,
    \"url\": null,
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promo-photos/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "prm_id": null,
    "usr_id": null,
    "url": null,
    "name": null
};

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

Request   

PUT v1/promo-photos/{id}

PATCH v1/promo-photos/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promo photo.

Body Parameters

id   string  optional  
prm_id   string   

Must contain only letters, numbers, dashes and underscores. The prm_id of an existing record in the promo table. Must be between 1 and 36 characters.

usr_id   string   

The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

url   string   
name   string   

Must not be greater than 255 characters.

Promo-Selected-Type

Retrieve by promo id

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promo-selected-type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promo-selected-type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promo-selected-type/{promo}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

promo   string   

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promo-selected-type" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/promo-selected-type"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promo-selected-type

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promo-selected-type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promo-selected-type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promo-selected-type/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promo selected type.

Promotional-Activities

Retrieve by group

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promotional-activities/group/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activities/group/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promotional-activities/group/{group}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

group   string   

The group.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promotional-activities" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activities"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promotional-activities

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/promotional-activities" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"pml_activity\": null,
    \"pml_buy_start_date\": null,
    \"pml_buy_end_date\": null,
    \"pml_sell_start_date\": null,
    \"pml_sell_end_date\": null,
    \"pml_discount\": null,
    \"pml_luc\": null,
    \"pml_rrp\": null,
    \"pml_valid\": null,
    \"pml_free_form\": null,
    \"pml_note\": null,
    \"sta_name\": null,
    \"act_id\": null,
    \"ban_id\": null,
    \"osg_id\": null,
    \"who_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activities"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "pml_activity": null,
    "pml_buy_start_date": null,
    "pml_buy_end_date": null,
    "pml_sell_start_date": null,
    "pml_sell_end_date": null,
    "pml_discount": null,
    "pml_luc": null,
    "pml_rrp": null,
    "pml_valid": null,
    "pml_free_form": null,
    "pml_note": null,
    "sta_name": null,
    "act_id": null,
    "ban_id": null,
    "osg_id": null,
    "who_id": null
};

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

Request   

POST v1/promotional-activities

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

pml_group_id   integer  optional  
pml_activity   string   

The pml_activity of an existing record in the activity_name table.

pml_buy_start_date   string   

Must be a valid date in the format Y:m:d.

pml_buy_end_date   string   

Must be a valid date in the format Y:m:d.

pml_sell_start_date   string   

Must be a valid date in the format Y:m:d.

pml_sell_end_date   string   

Must be a valid date in the format Y:m:d.

pml_discount   number   
pml_luc   number   
pml_rrp   number   
pml_valid   string   
Must be one of:
  • 1
  • 0
pml_free_form   string   

Must not be greater than 255 characters.

pml_note   string   

Must not be greater than 50 characters.

sta_name   string   

The sta_name of an existing record in the state table.

act_id   string   

The act_id of an existing record in the account table.

ban_id   string   

The ban_id of an existing record in the banner table.

osg_id   string   

The osg_id of an existing record in the ownership_group table.

who_id   string   

The who_id of an existing record in the wholesaler table.

pro_id   integer  optional  

The pro_id of an existing record in the product table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promotional-activities/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activities/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promotional-activities/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/promotional-activities/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"promotional_activities\": null,
    \"pml_activity\": null,
    \"pml_buy_start_date\": null,
    \"pml_buy_end_date\": null,
    \"pml_sell_start_date\": null,
    \"pml_sell_end_date\": null,
    \"pml_discount\": null,
    \"pml_luc\": null,
    \"pml_rrp\": null,
    \"pml_valid\": null,
    \"pml_free_form\": null,
    \"pml_note\": null,
    \"sta_name\": null,
    \"act_id\": null,
    \"ban_id\": null,
    \"osg_id\": null,
    \"who_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activities/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "promotional_activities": null,
    "pml_activity": null,
    "pml_buy_start_date": null,
    "pml_buy_end_date": null,
    "pml_sell_start_date": null,
    "pml_sell_end_date": null,
    "pml_discount": null,
    "pml_luc": null,
    "pml_rrp": null,
    "pml_valid": null,
    "pml_free_form": null,
    "pml_note": null,
    "sta_name": null,
    "act_id": null,
    "ban_id": null,
    "osg_id": null,
    "who_id": null
};

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

Request   

PUT v1/promotional-activities/{id}

PATCH v1/promotional-activities/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity.

Body Parameters

promotional_activities   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

pml_group_id   integer  optional  
pml_activity   string   

The pml_activity of an existing record in the activity_name table.

pml_buy_start_date   string   

Must be a valid date in the format Y:m:d.

pml_buy_end_date   string   

Must be a valid date in the format Y:m:d.

pml_sell_start_date   string   

Must be a valid date in the format Y:m:d.

pml_sell_end_date   string   

Must be a valid date in the format Y:m:d.

pml_discount   number   
pml_luc   number   
pml_rrp   number   
pml_valid   string   
Must be one of:
  • 1
  • 0
pml_free_form   string   

Must not be greater than 255 characters.

pml_note   string   

Must not be greater than 50 characters.

sta_name   string   

The sta_name of an existing record in the state table.

act_id   string   

The act_id of an existing record in the account table.

ban_id   string   

The ban_id of an existing record in the banner table.

osg_id   string   

The osg_id of an existing record in the ownership_group table.

who_id   string   

The who_id of an existing record in the wholesaler table.

pro_id   integer  optional  

The pro_id of an existing record in the product table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/promotional-activities/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activities/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/promotional-activities/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity.

Promotional-Activity-Names

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promotional-activity-names" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-names"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promotional-activity-names

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/promotional-activity-names" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"pml_activity\": null,
    \"acn_name\": null,
    \"activity_type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-names"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "pml_activity": null,
    "acn_name": null,
    "activity_type": null
};

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

Request   

POST v1/promotional-activity-names

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

pml_activity   string   

Must not be greater than 20 characters.

acn_name   string   

Must not be greater than 255 characters.

activity_type   string   

The id of an existing record in the activity_type table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promotional-activity-names/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-names/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promotional-activity-names/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity name.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/promotional-activity-names/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"promotional_activity_names\": null,
    \"acn_name\": null,
    \"activity_type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-names/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "promotional_activity_names": null,
    "acn_name": null,
    "activity_type": null
};

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

Request   

PUT v1/promotional-activity-names/{id}

PATCH v1/promotional-activity-names/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity name.

Body Parameters

promotional_activity_names   string   

Must not be greater than 20 characters.

acn_name   string   

Must not be greater than 255 characters.

activity_type   string   

The id of an existing record in the activity_type table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/promotional-activity-names/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-names/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/promotional-activity-names/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity name.

Promotional-Activity-Types

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promotional-activity-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promotional-activity-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/promotional-activity-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "type": null
};

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

Request   

POST v1/promotional-activity-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

type   string   

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/promotional-activity-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/promotional-activity-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity type.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/promotional-activity-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"promotional_activity_types\": null,
    \"type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "promotional_activity_types": null,
    "type": null
};

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

Request   

PUT v1/promotional-activity-types/{id}

PATCH v1/promotional-activity-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity type.

Body Parameters

promotional_activity_types   string   

Must be between 1 and 11 digits.

type   string   

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/promotional-activity-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/promotional-activity-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/promotional-activity-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the promotional activity type.

Questions

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/questions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/questions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/questions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/questions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"question\": null,
    \"premise_type\": null,
    \"response_type\": null,
    \"visible\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/questions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "question": null,
    "premise_type": null,
    "response_type": null,
    "visible": null
};

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

Request   

POST v1/questions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

reference_id_1   string  optional  

Must not be greater than 255 characters.

reference_id_2   string  optional  

Must not be greater than 255 characters.

question   string   

Must not be greater than 255 characters.

premise_type   string   
Must be one of:
  • 1
  • 2
response_type   string   
Must be one of:
  • 1
  • 2
  • 3
visible   string   
Must be one of:
  • 0
  • 1

GET v1/questions/{id}

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the question.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"questions\": null,
    \"question\": null,
    \"premise_type\": null,
    \"response_type\": null,
    \"visible\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "questions": null,
    "question": null,
    "premise_type": null,
    "response_type": null,
    "visible": null
};

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

Request   

PUT v1/questions/{id}

PATCH v1/questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the question.

Body Parameters

questions   string   

Must be between 1 and 11 digits.

reference_id_1   string  optional  

Must not be greater than 255 characters.

reference_id_2   string  optional  

Must not be greater than 255 characters.

question   string   

Must not be greater than 255 characters.

premise_type   string   
Must be one of:
  • 1
  • 2
response_type   string   
Must be one of:
  • 1
  • 2
  • 3
visible   string   
Must be one of:
  • 0
  • 1

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/questions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/questions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/questions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the question.

Sales

Update multiple

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/sales" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"sale\": [
        {
            \"id\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sales"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "sale": [
        {
            "id": null
        }
    ]
};

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

Request   

PUT v1/sales

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

sale   object[]  optional  
id   string   

The id of an existing record in the sales table. Must not be greater than 36 characters.

account_id   string  optional  

The act_id of an existing record in the account table. Must not be greater than 45 characters.

product_id   string  optional  

The pro_id of an existing record in the product table. Must not be greater than 45 characters.

field   string  optional  

Must not be greater than 45 characters.

value   string  optional  

Must not be greater than 45 characters.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/sales" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/sales"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/sales

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/sales" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"account_id\": null,
    \"product_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sales"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "account_id": null,
    "product_id": null
};

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

Request   

POST v1/sales

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

account_id   string   

The act_id of an existing record in the account table. Must not be greater than 45 characters.

product_id   string   

The pro_id of an existing record in the product table. Must not be greater than 45 characters.

field   string  optional  

Must not be greater than 45 characters.

value   string  optional  

Must not be greater than 45 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/sales/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/sales/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/sales/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sale.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/sales/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"sales\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sales/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "sales": null
};

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

Request   

PUT v1/sales/{id}

PATCH v1/sales/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sale.

Body Parameters

sales   string   

Must be between 1 and 11 digits.

account_id   string  optional  

The act_id of an existing record in the account table. Must not be greater than 45 characters.

product_id   string  optional  

The pro_id of an existing record in the product table. Must not be greater than 45 characters.

field   string  optional  

Must not be greater than 45 characters.

value   string  optional  

Must not be greater than 45 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/sales/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/sales/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/sales/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sale.

Sales-Data

Update multiple

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/sales-data" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"upsert\": null,
    \"sales\": [
        {
            \"act_id\": null,
            \"pro_id\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sales-data"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "upsert": null,
    "sales": [
        {
            "act_id": null,
            "pro_id": null
        }
    ]
};

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

Request   

PUT v1/sales-data

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

upsert   string   
Must be one of:
  • 1
  • 0
sales   object[]  optional  
sad_this_month   string  optional  

Must not be greater than 20 characters.

sad_prior_month   string  optional  

Must not be greater than 20 characters.

sad_this_month_vary   string  optional  

Must not be greater than 20 characters.

sad_MQT   string  optional  

Must not be greater than 20 characters.

sad_prior_MQT   string  optional  

Must not be greater than 20 characters.

sad_MQT_vary   string  optional  

Must not be greater than 20 characters.

sad_MAT   string  optional  

Must not be greater than 20 characters.

sad_prior_MAT   string  optional  

Must not be greater than 20 characters.

sad_MAT_vary   string  optional  

Must not be greater than 20 characters.

sad_order   integer  optional  
act_id   string   

The act_id of an existing record in the account table. Must not be greater than 36 characters.

pro_id   integer   

The pro_id of an existing record in the product table.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/sales-data" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/sales-data"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/sales-data

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/sales-data" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"act_id\": null,
    \"pro_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sales-data"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "act_id": null,
    "pro_id": null
};

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

Request   

POST v1/sales-data

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

sad_this_month   string  optional  

Must not be greater than 20 characters.

sad_prior_month   string  optional  

Must not be greater than 20 characters.

sad_this_month_vary   string  optional  

Must not be greater than 20 characters.

sad_MQT   string  optional  

Must not be greater than 20 characters.

sad_prior_MQT   string  optional  

Must not be greater than 20 characters.

sad_MQT_vary   string  optional  

Must not be greater than 20 characters.

sad_MAT   string  optional  

Must not be greater than 20 characters.

sad_prior_MAT   string  optional  

Must not be greater than 20 characters.

sad_MAT_vary   string  optional  

Must not be greater than 20 characters.

sad_order   integer  optional  
act_id   string   

The act_id of an existing record in the account table. Must not be greater than 36 characters.

pro_id   integer   

The pro_id of an existing record in the product table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/sales-data/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/sales-data/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/sales-data/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sales datum.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/sales-data/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"sales_data\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sales-data/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "sales_data": null
};

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

Request   

PUT v1/sales-data/{id}

PATCH v1/sales-data/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sales datum.

Body Parameters

sales_data   string   

Must be between 1 and 11 digits.

sad_this_month   string  optional  

Must not be greater than 20 characters.

sad_prior_month   string  optional  

Must not be greater than 20 characters.

sad_this_month_vary   string  optional  

Must not be greater than 20 characters.

sad_MQT   string  optional  

Must not be greater than 20 characters.

sad_prior_MQT   string  optional  

Must not be greater than 20 characters.

sad_MQT_vary   string  optional  

Must not be greater than 20 characters.

sad_MAT   string  optional  

Must not be greater than 20 characters.

sad_prior_MAT   string  optional  

Must not be greater than 20 characters.

sad_MAT_vary   string  optional  

Must not be greater than 20 characters.

sad_order   integer  optional  
act_id   string  optional  

The act_id of an existing record in the account table. Must not be greater than 36 characters.

pro_id   integer  optional  

The pro_id of an existing record in the product table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/sales-data/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/sales-data/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/sales-data/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sales datum.

Selling-Area-Categories

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/selling-area-categories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/selling-area-categories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/selling-area-categories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/selling-area-categories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"sac_name\": null,
    \"sac_parent_id\": null,
    \"sac_act_type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/selling-area-categories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "sac_name": null,
    "sac_parent_id": null,
    "sac_act_type": null
};

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

Request   

POST v1/selling-area-categories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

sac_name   string   

Must not be greater than 255 characters.

sac_parent_id   integer   

The sac_id of an existing record in the selling_area_category table.

sac_act_type   string   
Must be one of:
  • ON
  • OFF

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/selling-area-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/selling-area-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/selling-area-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the selling area category.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/selling-area-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"selling_area_categories\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/selling-area-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "selling_area_categories": null
};

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

Request   

PUT v1/selling-area-categories/{id}

PATCH v1/selling-area-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the selling area category.

Body Parameters

selling_area_categories   string   

Must be between 1 and 10 digits.

sac_name   string  optional  

Must not be greater than 255 characters.

sac_parent_id   integer  optional  

The sac_id of an existing record in the selling_area_category table.

sac_act_type   string  optional  
Must be one of:
  • ON
  • OFF

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/selling-area-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/selling-area-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/selling-area-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the selling area category.

Selling-Areas

Retrieve by Account

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/selling-areas/account/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/selling-areas/account/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/selling-areas/account/{account}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

account   string   

The account.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/selling-areas" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/selling-areas"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/selling-areas

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/selling-areas" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"sea_note\": null,
    \"act_id\": null,
    \"sea_total_tap\": null,
    \"sea_area_position\": null,
    \"are_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/selling-areas"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "sea_note": null,
    "act_id": null,
    "sea_total_tap": null,
    "sea_area_position": null,
    "are_id": null
};

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

Request   

POST v1/selling-areas

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

sea_note   string   
act_id   string   

The act_id of an existing record in the account table.

sea_total_tap   integer   

Must not be greater than 11.

sea_area_position   integer   

Must not be greater than 11.

are_id   integer   

The are_id of an existing record in the area table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/selling-areas/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/selling-areas/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/selling-areas/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the selling area.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/selling-areas/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"selling_areas\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/selling-areas/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "selling_areas": null
};

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

Request   

PUT v1/selling-areas/{id}

PATCH v1/selling-areas/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the selling area.

Body Parameters

selling_areas   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

sea_note   string  optional  
act_id   string  optional  

The act_id of an existing record in the account table.

sea_total_tap   integer  optional  

Must not be greater than 11.

sea_area_position   integer  optional  

Must not be greater than 11.

are_id   integer  optional  

The are_id of an existing record in the area table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/selling-areas/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/selling-areas/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/selling-areas/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the selling area.

Sizes

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/sizes" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/sizes"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/sizes

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/sizes" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"siz_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sizes"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "siz_name": null
};

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

Request   

POST v1/sizes

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

siz_name   string   

Must not be greater than 40 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/sizes/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/sizes/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/sizes/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the size.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/sizes/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"siz_name\": null,
    \"sizes\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sizes/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "siz_name": null,
    "sizes": null
};

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

Request   

PUT v1/sizes/{id}

PATCH v1/sizes/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the size.

Body Parameters

siz_name   string   

Must not be greater than 40 characters.

sizes   string   

Must be between 1 and 11 digits.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/sizes/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/sizes/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/sizes/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the size.

States

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/states" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/states"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/states

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/states" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"sta_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/states"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "sta_name": null
};

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

Request   

POST v1/states

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

sta_name   string   

Must not be greater than 3 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/states/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/states/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/states/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the state.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/states/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"states\": null,
    \"sta_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/states/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "states": null,
    "sta_name": null
};

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

Request   

PUT v1/states/{id}

PATCH v1/states/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the state.

Body Parameters

states   string   

Must be between 1 and 11 digits.

sta_name   string   

Must not be greater than 3 characters.

Sub-Selection-Answers

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/sub-selection-answers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/sub-selection-answers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/sub-selection-answers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/sub-selection-answers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"answer_id\": null,
    \"answer\": null,
    \"sub_answer_type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sub-selection-answers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "answer_id": null,
    "answer": null,
    "sub_answer_type": null
};

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

Request   

POST v1/sub-selection-answers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

answer_id   string   

Must contain only letters, numbers, dashes and underscores. The id of an existing record in the answers table. Must be between 1 and 36 characters.

answer   string   

Must not be greater than 255 characters.

sub_answer_type   string   
Must be one of:
  • 1
  • 2

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/sub-selection-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/sub-selection-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/sub-selection-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sub selection answer.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/sub-selection-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"answer_id\": null,
    \"answer\": null,
    \"sub_answer_type\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/sub-selection-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "answer_id": null,
    "answer": null,
    "sub_answer_type": null
};

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

Request   

PUT v1/sub-selection-answers/{id}

PATCH v1/sub-selection-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sub selection answer.

Body Parameters

answer_id   string   

Must contain only letters, numbers, dashes and underscores. The id of an existing record in the answers table. Must be between 1 and 36 characters.

answer   string   

Must not be greater than 255 characters.

sub_answer_type   string   
Must be one of:
  • 1
  • 2
id   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/sub-selection-answers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/sub-selection-answers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/sub-selection-answers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the sub selection answer.

Tap-Categories

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/tap-categories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-categories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/tap-categories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/tap-categories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"tac_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-categories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "tac_name": null
};

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

Request   

POST v1/tap-categories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

tac_name   string   

Must not be greater than 40 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/tap-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/tap-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/tap-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap category.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/tap-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"tap_categories\": null,
    \"tac_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "tap_categories": null,
    "tac_name": null
};

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

Request   

PUT v1/tap-categories/{id}

PATCH v1/tap-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap category.

Body Parameters

tap_categories   string   

Must be between 1 and 11 digits.

tac_name   string   

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/tap-categories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/tap-categories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/tap-categories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap category.

Tap-Type

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/tap-type" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/tap-type

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/tap-type" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null,
    \"tap_type_name_id\": null,
    \"visible\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null,
    "tap_type_name_id": null,
    "visible": null
};

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

Request   

POST v1/tap-type

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

name   string   

Must not be greater than 1000 characters.

tap_type_name_id   integer   

The id of an existing record in the tap_type_name table.

visible   boolean   

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/tap-type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/tap-type/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap type.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/tap-type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "name": null
};

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

Request   

PUT v1/tap-type/{id}

PATCH v1/tap-type/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap type.

Body Parameters

name   string   

Must not be greater than 255 characters.

tap_type_name_id   integer  optional  

The id of an existing record in the tap_type_name table.

visible   boolean  optional  
id   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/tap-type/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/tap-type/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap type.

Tap-Type-Selection

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/tap-type-selection" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type-selection"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/tap-type-selection

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/tap-type-selection" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"account_agreement_id\": null,
    \"act_id\": null,
    \"tap_type_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type-selection"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "account_agreement_id": null,
    "act_id": null,
    "tap_type_id": null
};

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

Request   

POST v1/tap-type-selection

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

account_agreement_id   integer   

The id of an existing record in the account_agreement table.

act_id   string   

The act_id of an existing record in the account table.

tap_type_id   integer   

The id of an existing record in the tap_type table.

tap_id   integer  optional  

The tap_id of an existing record in the tap table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/tap-type-selection/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type-selection/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/tap-type-selection/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap type selection.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/tap-type-selection/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type-selection/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

PUT v1/tap-type-selection/{id}

PATCH v1/tap-type-selection/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap type selection.

Body Parameters

account_agreement_id   integer  optional  

The id of an existing record in the account_agreement table.

act_id   string  optional  

The act_id of an existing record in the account table.

tap_type_id   integer  optional  

The id of an existing record in the tap_type table.

tap_id   integer  optional  

The tap_id of an existing record in the tap table.

id   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/tap-type-selection/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/tap-type-selection/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/tap-type-selection/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap type selection.

Taps

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/taps" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/taps"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/taps

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/taps" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"tap_name\": null,
    \"tap_description\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/taps"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "tap_name": null,
    "tap_description": null
};

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

Request   

POST v1/taps

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

tap_name   string   

Must not be greater than 255 characters.

tap_description   string   

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/taps/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/taps/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/taps/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/taps/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"taps\": null,
    \"tap_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/taps/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "taps": null,
    "tap_name": null
};

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

Request   

PUT v1/taps/{id}

PATCH v1/taps/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap.

Body Parameters

taps   string   

Must be between 1 and 11 digits.

tap_name   string   

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/taps/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/taps/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/taps/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the tap.

Territories

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/territories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/territories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/territories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/territories/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/territories/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/territories/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the territory.

Trade-Promotion-Types

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/trade-promotion-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/trade-promotion-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/trade-promotion-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/trade-promotion-types" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"pmt_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/trade-promotion-types"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "pmt_name": null
};

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

Request   

POST v1/trade-promotion-types

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

pmt_name   string   

Must not be greater than 45 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/trade-promotion-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/trade-promotion-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/trade-promotion-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the trade promotion type.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/trade-promotion-types/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"trade_promotion_types\": null,
    \"pmt_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/trade-promotion-types/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "trade_promotion_types": null,
    "pmt_name": null
};

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

Request   

PUT v1/trade-promotion-types/{id}

PATCH v1/trade-promotion-types/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the trade promotion type.

Body Parameters

trade_promotion_types   string   

Must be between 1 and 11 digits.

pmt_name   string   

Must not be greater than 45 characters.

Turn-In-Order-Products

Retrieve by order

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/turn-in-order-products/turn-in-order/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-order-products/turn-in-order/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/turn-in-order-products/turn-in-order/{order}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

order   string   

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/turn-in-order-products" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-order-products"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/turn-in-order-products

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/turn-in-order-products" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"tip_id\": null,
    \"tio_id\": null,
    \"pro_id\": null,
    \"tip_quantity\": null,
    \"tip_sequence\": null,
    \"is_bonus\": null,
    \"bonus_type_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-order-products"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "tip_id": null,
    "tio_id": null,
    "pro_id": null,
    "tip_quantity": null,
    "tip_sequence": null,
    "is_bonus": null,
    "bonus_type_id": null
};

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

Request   

POST v1/turn-in-order-products

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

tip_id   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

tio_id   string   

The tio_id of an existing record in the turninorder table.

pro_id   string   

The pro_id of an existing record in the product table.

tip_quantity   integer   
tip_sequence   integer   
tip_product_note   string  optional  

Must not be greater than 255 characters.

uom   integer  optional  
is_bonus   string   
Must be one of:
  • 1
  • 0
bonus_type_id   string   

The bonus_type_id of an existing record in the bonus_type table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/turn-in-order-products/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-order-products/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/turn-in-order-products/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the turn in order product.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/turn-in-order-products/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"turn_in_order_products\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-order-products/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "turn_in_order_products": null
};

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

Request   

PUT v1/turn-in-order-products/{id}

PATCH v1/turn-in-order-products/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the turn in order product.

Body Parameters

turn_in_order_products   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

tio_id   string  optional  

The tio_id of an existing record in the turninorder table.

pro_id   string  optional  

The pro_id of an existing record in the product table.

tip_quantity   integer  optional  
tip_sequence   integer  optional  
tip_product_note   string  optional  

Must not be greater than 255 characters.

uom   integer  optional  
is_bonus   string  optional  
Must be one of:
  • 1
  • 0
bonus_type_id   string  optional  

The bonus_type_id of an existing record in the bonus_type table.

tip_id   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/turn-in-order-products/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-order-products/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/turn-in-order-products/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the turn in order product.

Turn-In-Orders

Retrieve by Exported

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/turn-in-orders/exported/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-orders/exported/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/turn-in-orders/exported/{exported}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

exported   string   

The exported.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/turn-in-orders" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-orders"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/turn-in-orders

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/turn-in-orders" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"tio_id\": null,
    \"act_id\": null,
    \"usr_id\": null,
    \"tio_date\": null,
    \"tio_email_flag\": null,
    \"tio_ponumber\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-orders"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "tio_id": null,
    "act_id": null,
    "usr_id": null,
    "tio_date": null,
    "tio_email_flag": null,
    "tio_ponumber": null
};

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

Request   

POST v1/turn-in-orders

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

tio_id   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

act_id   string   

The act_id of an existing record in the account table.

usr_id   string   

The usr_id of an existing record in the user table.

tio_date   string   

Must be a valid date in the format Y:m:d.

tio_email_flag   string   
Must be one of:
  • TRUE
  • FALSE
tio_ponumber   string   

Must be between 1 and 255 characters.

tio_note   string  optional  

Must be between 1 and 255 characters.

tio_delivery_date   string  optional  

Must be a valid date in the format Y:m:d.

tio_exported   string  optional  
Must be one of:
  • TRUE
  • FALSE
tio_num_products   integer  optional  
who_id   string  optional  

The who_id of an existing record in the wholesaler table.

who_code   string  optional  

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 20 characters.

delivery_address_id   string  optional  

The adl_id of an existing record in the account_delivery table.

sent_to_server   string  optional  
Must be one of:
  • 1
  • 0

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/turn-in-orders/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-orders/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/turn-in-orders/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the turn in order.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/turn-in-orders/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"turn_in_orders\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-orders/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "turn_in_orders": null
};

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

Request   

PUT v1/turn-in-orders/{id}

PATCH v1/turn-in-orders/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the turn in order.

Body Parameters

turn_in_orders   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

act_id   string  optional  

The act_id of an existing record in the account table.

usr_id   string  optional  

The usr_id of an existing record in the user table.

tio_date   string  optional  

Must be a valid date in the format Y:m:d.

tio_email_flag   string  optional  
Must be one of:
  • TRUE
  • FALSE
tio_ponumber   string  optional  

Must be between 1 and 255 characters.

tio_note   string  optional  

Must be between 1 and 255 characters.

tio_delivery_date   string  optional  

Must be a valid date in the format Y:m:d.

tio_exported   string  optional  
Must be one of:
  • TRUE
  • FALSE
tio_num_products   integer  optional  
who_id   string  optional  

The who_id of an existing record in the wholesaler table.

who_code   string  optional  

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 20 characters.

delivery_address_id   string  optional  

The adl_id of an existing record in the account_delivery table.

sent_to_server   string  optional  
Must be one of:
  • 1
  • 0
tio_id   string  optional  

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/turn-in-orders/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/turn-in-orders/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/turn-in-orders/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the turn in order.

User-Admin-Modules

Allocate a specific admin-module to a user. This gives the user permission to access and view the admin-module on rhino online.

See the admin-modules resource for a list of all possible modules.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-admin-modules" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/user-admin-modules"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-admin-modules

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/user-admin-modules" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"user_id\": null,
    \"admin_module_id\": null,
    \"active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/user-admin-modules"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "user_id": null,
    "admin_module_id": null,
    "active": null
};

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

Request   

POST v1/user-admin-modules

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

user_id   string   

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

admin_module_id   integer   

The id of an existing record in the admin_modules table.

active   integer   
Must be one of:
  • 1
  • 0

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-admin-modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-admin-modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-admin-modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user admin module.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/user-admin-modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"user_admin_modules\": null,
    \"active\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/user-admin-modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "user_admin_modules": null,
    "active": null
};

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

Request   

PUT v1/user-admin-modules/{id}

PATCH v1/user-admin-modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user admin module.

Body Parameters

user_admin_modules   string   

Must be between 1 and 11 digits.

user_id   string  optional  

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

admin_module_id   integer  optional  

The id of an existing record in the admin_modules table.

active   integer   
Must be one of:
  • 1
  • 0

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/user-admin-modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-admin-modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/user-admin-modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user admin module.

User-Modules

User-Modules are specifically used for the Android app only. Please use the User-Admin-Modules resource for the web version.

See the Modules resource for a list of all possible modules on the Android app.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-modules" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/user-modules"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-modules

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/user-modules" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"usr_id\": null,
    \"mod_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/user-modules"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "usr_id": null,
    "mod_id": null
};

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

Request   

POST v1/user-modules

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

usr_id   string   

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

mod_id   integer   

The mod_id of an existing record in the module table.

usm_activated   string  optional  
Must be one of:
  • true
  • false

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user module.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/user-modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"user_modules\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/user-modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "user_modules": null
};

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

Request   

PUT v1/user-modules/{id}

PATCH v1/user-modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user module.

Body Parameters

user_modules   string   

Must be between 1 and 11 digits.

usr_id   string  optional  

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

mod_id   integer  optional  

The mod_id of an existing record in the module table.

usm_activated   string  optional  
Must be one of:
  • true
  • false

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/user-modules/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-modules/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/user-modules/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user module.

Retrieve by User

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-modules/user/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-modules/user/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-modules/user/{user}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

user   string   

The user.

Retrieve by Module

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-modules/module/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-modules/module/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-modules/module/{module}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

module   string   

The module.

User-Permissions

Allocate a permission level to a user, to restrict there access to all other users. This is useful when you do NOT want users to see each others calls, reports etc.

By default all users are given Territory Level permissions.

Possible values for permission_level

1 User Level. Only access there own records.
2 Territory Level. Only access records belonging to users within there own territory.
3 Admin Level. Access all records. 4 User/All Accounts Level. Dropdowns show logged in user, but can see all accounts. 5 User/State Accounts Level. Dropdowns show logged in user, but can see all accounts in there state. 6 User/Filtered Accounts Level. Dropdowns show logged in user, but can see accounts based on Permission_Filters. 7 User/Territory Accounts Level. Dropdowns show logged in user, but can see accounts in their territory. 8 Territory/Filtered Accounts Level. Dropdowns shows users in their own territory, can see accounts in their territory.

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-permissions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/user-permissions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-permissions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/user-permissions" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"user_id\": null,
    \"permission_level\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/user-permissions"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "user_id": null,
    "permission_level": null
};

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

Request   

POST v1/user-permissions

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

user_id   string   

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

permission_level   integer   
Must be one of:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-permissions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-permissions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-permissions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user permission.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/user-permissions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"user_permissions\": null,
    \"user_id\": null,
    \"permission_level\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/user-permissions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "user_permissions": null,
    "user_id": null,
    "permission_level": null
};

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

Request   

PUT v1/user-permissions/{id}

PATCH v1/user-permissions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user permission.

Body Parameters

user_permissions   string   

Must be between 1 and 11 digits.

user_id   string   

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

permission_level   integer   
Must be one of:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/user-permissions/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-permissions/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/user-permissions/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user permission.

User-Territories

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-territories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/user-territories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-territories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/user-territories" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"user_id\": null,
    \"territory_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/user-territories"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "user_id": null,
    "territory_id": null
};

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

Request   

POST v1/user-territories

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

user_id   string   

Must contain only letters, numbers, dashes and underscores. The usr_id of an existing record in the user table. Must be between 1 and 36 characters.

territory_id   string   

Must be between 1 and 11 digits. The id of an existing record in the territory table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-territories/user//territory/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-territories/user//territory/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-territories/user/{user}/territory/{territory}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

user   string   

The user.

territory   string   

The territory.

Retrieve by user

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-territories/user/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-territories/user/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-territories/user/{user}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

user   string   

The user.

Retrieve by territory

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/user-territories/territory/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/user-territories/territory/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/user-territories/territory/{territory}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

territory   string   

The territory.

Users

Update multiple

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/users" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"user\": [
        {
            \"id\": null,
            \"username\": null,
            \"name\": null,
            \"code\": null,
            \"reference_id\": null,
            \"email\": null,
            \"password\": null,
            \"password_type\": null,
            \"state\": null,
            \"reportable\": null,
            \"tablet_access\": null,
            \"admin_access\": null
        }
    ]
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/users"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "user": [
        {
            "id": null,
            "username": null,
            "name": null,
            "code": null,
            "reference_id": null,
            "email": null,
            "password": null,
            "password_type": null,
            "state": null,
            "reportable": null,
            "tablet_access": null,
            "admin_access": null
        }
    ]
};

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

Request   

PUT v1/users

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

user   object[]   

Must have at least 1 items. Must not have more than 50 items.
id   string   

Must not be greater than 255 characters.

username   string   

Must not be greater than 255 characters.

name   string   

Must not be greater than 255 characters.

code   string   

Must not be greater than 255 characters.

reference_id   string   

Must not be greater than 255 characters.

email   string   

Must be a valid email address.

password   string   

Must not be greater than 60 characters.

password_type   string   
Must be one of:
  • plain
  • ssha
state   string   

The sta_name of an existing record in the state table.

reportable   string   
Must be one of:
  • true
  • false
tablet_access   string   
Must be one of:
  • Enabled
  • Disabled
admin_access   string   
Must be one of:
  • Enabled
  • Disabled

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/users" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/users"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/users

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/users" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"username\": null,
    \"name\": null,
    \"code\": null,
    \"reference_id\": null,
    \"email\": null,
    \"password\": null,
    \"password_type\": null,
    \"state\": null,
    \"reportable\": null,
    \"tablet_access\": null,
    \"admin_access\": null,
    \"isActive\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/users"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "username": null,
    "name": null,
    "code": null,
    "reference_id": null,
    "email": null,
    "password": null,
    "password_type": null,
    "state": null,
    "reportable": null,
    "tablet_access": null,
    "admin_access": null,
    "isActive": null
};

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

Request   

POST v1/users

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

username   string   

Must not be greater than 255 characters.

name   string   

Must not be greater than 255 characters.

code   string   

Must not be greater than 255 characters.

reference_id   string   

Must not be greater than 255 characters.

email   string   

Must be a valid email address. Must not be greater than 254 characters.

password   string   

Must not be greater than 60 characters.

password_type   string   
Must be one of:
  • plain
  • ssha
state   string   

The sta_name of an existing record in the state table.

reportable   string   
Must be one of:
  • true
  • false
tablet_access   string   
Must be one of:
  • Enabled
  • Disabled
admin_access   string   
Must be one of:
  • Enabled
  • Disabled
isActive   string   
Must be one of:
  • 1
  • 0

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/users/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/users/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/users/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/users/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"username\": null,
    \"name\": null,
    \"code\": null,
    \"reference_id\": null,
    \"email\": null,
    \"password\": null,
    \"password_type\": null,
    \"state\": null,
    \"reportable\": null,
    \"tablet_access\": null,
    \"admin_access\": null,
    \"isActive\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/users/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "username": null,
    "name": null,
    "code": null,
    "reference_id": null,
    "email": null,
    "password": null,
    "password_type": null,
    "state": null,
    "reportable": null,
    "tablet_access": null,
    "admin_access": null,
    "isActive": null
};

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

Request   

PUT v1/users/{id}

PATCH v1/users/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user.

Body Parameters

user_id   string  optional  
username   string   

Must not be greater than 255 characters.

name   string   

Must not be greater than 255 characters.

code   string   

Must not be greater than 255 characters.

reference_id   string   

Must not be greater than 255 characters.

email   string   

Must be a valid email address. Must not be greater than 254 characters.

password   string   

Must not be greater than 60 characters.

password_type   string   
Must be one of:
  • plain
  • ssha
state   string   

The sta_name of an existing record in the state table.

reportable   string   
Must be one of:
  • true
  • false
tablet_access   string   
Must be one of:
  • Enabled
  • Disabled
admin_access   string   
Must be one of:
  • Enabled
  • Disabled
isActive   string   
Must be one of:
  • 1
  • 0

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/users/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/users/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/users/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the user.

Weekly-Reports

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/weekly-reports" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/weekly-reports"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/weekly-reports

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/weekly-reports" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"rep_week_ending\": null,
    \"rep_submitted\": null,
    \"usr_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/weekly-reports"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "rep_week_ending": null,
    "rep_submitted": null,
    "usr_id": null
};

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

Request   

POST v1/weekly-reports

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

rep_highlight   string  optional  

Must not be greater than 500 characters.

rep_lowlight   string  optional  

Must not be greater than 500 characters.

rep_new_distribution   string  optional  

Must not be greater than 500 characters.

rep_lost_distribution   string  optional  

Must not be greater than 500 characters.

rep_competitor_activity   string  optional  

Must not be greater than 500 characters.

rep_week_ending   string   

Must be a valid date in the format Y:m:d.

rep_submitted   string   
Must be one of:
  • TRUE
  • FALSE
usr_id   string   

The usr_id of an existing record in the user table.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/weekly-reports/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/weekly-reports/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/weekly-reports/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the weekly report.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/weekly-reports/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"weekly_reports\": null,
    \"rep_week_ending\": null,
    \"rep_submitted\": null,
    \"usr_id\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/weekly-reports/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "weekly_reports": null,
    "rep_week_ending": null,
    "rep_submitted": null,
    "usr_id": null
};

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

Request   

PUT v1/weekly-reports/{id}

PATCH v1/weekly-reports/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the weekly report.

Body Parameters

weekly_reports   string   

Must contain only letters, numbers, dashes and underscores. Must be between 1 and 36 characters.

rep_highlight   string  optional  

Must not be greater than 500 characters.

rep_lowlight   string  optional  

Must not be greater than 500 characters.

rep_new_distribution   string  optional  

Must not be greater than 500 characters.

rep_lost_distribution   string  optional  

Must not be greater than 500 characters.

rep_competitor_activity   string  optional  

Must not be greater than 500 characters.

rep_week_ending   string   

Must be a valid date in the format Y:m:d.

rep_submitted   string   
Must be one of:
  • TRUE
  • FALSE
usr_id   string   

The usr_id of an existing record in the user table.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/weekly-reports/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/weekly-reports/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/weekly-reports/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the weekly report.

Wholesalers

Retrieve multiple

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/wholesalers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \

const url = new URL(
    "https://api.rhinocrm.io/v1/wholesalers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/wholesalers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

page   integer  optional  

Must be at least 1.

per_page   integer  optional  

Must be at least 1. Must not be greater than 1000.

updated_after   string  optional  

Must be a valid date in the format "Y-m-d H:i:s".

Store

requires authentication

Example request:
curl --request POST \
    "https://api.rhinocrm.io/v1/wholesalers" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"who_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/wholesalers"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "who_name": null
};

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

Request   

POST v1/wholesalers

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

Body Parameters

who_name   string   

Must not be greater than 255 characters.

Retrieve

requires authentication

Example request:
curl --request GET \
    --get "https://api.rhinocrm.io/v1/wholesalers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/wholesalers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

GET v1/wholesalers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the wholesaler.

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.rhinocrm.io/v1/wholesalers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;" \
    --data "{
    \"wholesalers\": null,
    \"who_name\": null
}"

const url = new URL(
    "https://api.rhinocrm.io/v1/wholesalers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

let body = {
    "wholesalers": null,
    "who_name": null
};

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

Request   

PUT v1/wholesalers/{id}

PATCH v1/wholesalers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the wholesaler.

Body Parameters

wholesalers   string   

Must be between 1 and 11 digits.

who_name   string   

Must not be greater than 255 characters.

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.rhinocrm.io/v1/wholesalers/" \
    --header "Authorization: Basic &lt;base64-encoded-value&gt;" \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --header "x-consumer: &lt;consumer-token&gt;"
const url = new URL(
    "https://api.rhinocrm.io/v1/wholesalers/"
);

const headers = {
    "Authorization": "Basic &lt;base64-encoded-value&gt;",
    "Accept": "application/json",
    "Content-Type": "application/json",
    "x-consumer": "&lt;consumer-token&gt;",
};

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

Request   

DELETE v1/wholesalers/{id}

Headers

Authorization      

Example: Basic <base64-encoded-value>

Accept      

Example: application/json

Content-Type      

Example: application/json

x-consumer      

Example: <consumer-token>

URL Parameters

id   string   

The ID of the wholesaler.