CentiaCRM - Documentación API

Auth

Profiles

Users

GetUsers

Companies

Contacts

Products

Opportunities

Tickets

Obtain the auth token of the user

POST https://www.centiacrm.com/developers/api/v1/auth

Request

Field	Type	Description
method	string	"Login"
parameters	object[]	An object with data for the method
email	string	User email
password	string	User password

Request example

{
"method": "Login",
"parameters": { "email": "test@mail.com", "password": "123456" }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
token	string	Authorization token
user	object[]	Logged user basic information
error optional	string	Error message

Response success example

{
"success": true,
"response": { "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjhmOTA...", "user": { "id": 1, "name": "Joe", "last_name": "Doe", "mother_last_name": "Moe", "company_id": "1", "profile_id": "1" } }
}

Response error example

{
"success": false,
"response": null,
"error": "Unauthorized"
}

GetProfiles

Gets a list of profiles for the logged user

POST https://www.centiacrm.com/developers/api/v1/profiles

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetProfiles"

Request example

{
"method": "GetProfiles",
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
profiles	object[]	List of profile objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "profiles": [ { "id": 1, "name": "Test", "description": "This is a description" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "No profiles found"
}

GetStages

Gets a list of stages of selected profile

POST https://www.centiacrm.com/developers/api/v1/profiles

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetStages"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetStages",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
stages	object[]	List of stage objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "stages": [ { "id": 1, "profile_id": "1", "label": "Stage 1", "description": "This is a description", "probability": "10", "order": "1", "authorization_required": false } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Profile not found"
}

GetCountries

Gets a list of valid countries

POST https://www.centiacrm.com/developers/api/v1/profiles

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetCountries"

Request example

{
"method": "GetCountries"
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
countries	object[]	List of countries
error optional	string	Error message

Response success example

{
"success": true,
"response": { "countries": { "AF": "Afghanistan", "AX": "Åland Islands", "AL": "Albania", "DZ": "Algeria", "AS": "American Samoa", "AD": "Andorra" } }
}

Response error example

{
"success": false,
"response": null,
"error": "Invalid method"
}

GetStates

Gets a list of states of selected country

POST https://www.centiacrm.com/developers/api/v1/profiles

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetStates"
parameters	object[]	An object with data for the method
country	string	The code of the country

Request example

{
"method": "GetStates",
"parameters": { "country": "MX" }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
country	MX	Code of country
states	object[]	List of states
error optional	string	Error message

Response success example

{
"success": true,
"response": { "country": "MX", "states": { "DIF": "Ciudad de México", "AGU": "Aguascalientes", "BCN": "Baja California", "BCS": "Baja California Sur", "CAM": "Campeche" } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetUsers

Gets a list of users

POST https://www.centiacrm.com/developers/api/v1/users

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetUsers"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetUsers",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
users	object[]	List of user objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "users": [ { "id": 1, "profile_id": "1", "company_id": "1", "name": "Joe", "last_name": "Doe", "mother_last_name": "Moe", "email": "joe@test.com", "phone": "12341324", "phone_office": "12341234", "phone_mobile": "12341234" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Profile not found"
}

GetCompanies

Gets a list of companies for selected profile

POST https://www.centiacrm.com/developers/api/v1/companies

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetCompanies"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
company_type optional	array[]	An array of company_type ids. Obtained from the Companies.GetTypes method
company_industry optional	array[]	An array of company_industry ids. Obtained from the Companies.GetIndustries method
created_at optional	object[]	An object containing the creation date ranges
from optional	string	The min created at date of the company. Use format DD/MM/YY
to optional	string	The max created at date of the company. Use format DD/MM/YY
with_inputs optional	boolean	Indicates if we want to include input information for each company
with_contacts optional	boolean	Indicates if we want to include contact information for each company
with_addresses optional	boolean	Indicates if we want to include disclosed address information for each company
query optional	string	Search query string
pagination optional	integer	Number of items to paginate. Default is 500
page optional	integer	Add this if you want to start on a specific page

Request example

{
"method": "GetCompanies",
"parameters": { "profile_id": 1, "company_type": [1,2], "company_industry": [1,2], "created_at": { "from": "01/01/2022", "to": "01/02/2022" }, "with_inputs": true, "query": null, "pagination": 15, "page": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
total	integer	Total number of opportunity objects
current_page	integer	Current results page of opportunity objects
last_page	integer	Last results page of opportunity objects
companies	object[]	List of company objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "total": 1, "current_page": 1, "last_page": 1, "companies": [ { "id": 1, "profile_id": "1", "folio": "1", "name": "Company 1", "billing_name": "Company 1", "rfc": "EEE1111HHH", "type_id": "1", "type": "Type 1", "industry_id": "1", "industry": "Industry 1", "website": "http://iiq.com", "phone": "5558889991", "billing_address": "address 1", "shipping_address": "address 2", "created_at": "19/01/2021", "inputs": [ { "id": 1, "input_id": 2, "label": "Label", "value": "my value" } ] }, ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetTypes

Gets a list of company types of selected profile

POST https://www.centiacrm.com/developers/api/v1/companies

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetTypes"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetTypes",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
types	object[]	List of type objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "types": [ { "id": 1, "profile_id": "1", "label": "Type 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetIndustries

Gets a list of industries of selected profile

POST https://www.centiacrm.com/developers/api/v1/companies

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetIndustries"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetIndustries",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
industries	object[]	List of industry objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "industries": [ { "id": 1, "profile_id": "1", "label": "Industry 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetInputs

Gets a list of company inputs of selected profile

POST https://www.centiacrm.com/developers/api/v1/companies

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetInputs"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetInputs",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
inputs	object[]	List of input objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "inputs": [ { "id": 1, "profile_id": "1", "label": "Input 1", "description": "My description", "type": "radio", "options": [ "option 1", "option 2" ] } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

CreateCompany

Creates a Company

POST https://www.centiacrm.com/developers/api/v1/companies

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"CreateCompany"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
name	string	The name of the Company
type_id	integer	The id of the company type
industry_id	integer	The id of the company industry
website optional	string	The website of the company
phone optional	string	The phone of the company
billing_name optional	string	The billing name of the company
rfc optional	string	The rfc of the company
shipping_address optional	object[]	An object containing the shipping address of the company
country	string	The country code. Obtained from the Profiles.GetCountries method
state	string	The state code. Obtained from the Profiles.GetStates method
street	string	The street address
number	string	The number of the house
interior_number	string	The interior number if any
zip	string	The zip code
suburb	string	The suburb if any
city	string	The city
latitude optional	string	The latitude coordinate
longitude optional	string	The longitude coordinate
billing_address optional	object[]	An object containing the billing address of the company
country	string	The country code. Obtained from the Profiles.GetCountries method
state	string	The state code. Obtained from the Profiles.GetStates method
street	string	The street address
number	string	The number of the house
interior_number	string	The interior number if any
zip	string	The zip code
suburb	string	The suburb if any
city	string	The city
latitude optional	string	The latitude coordinate
longitude optional	string	The longitude coordinate

Request example

{
"method": "CreateCompany",
"parameters": { "profile_id": 1, "name": "Company 1", "type_id": 1, "industry_id": 1, "website": "http://iiq.com", "phone": "5558889991", "billing_name": "Company 1", "rfc": "EEE1111HHH", "shipping_address" : { "country": "MX", "state": "DIF", "street": "street_1", "number": "39", "interior_number": "", "zip": "07300", "suburb": "Ciudad de México", "city": "Ciudad de México", "latitude": "19.3472665", "longitude": "-99.0411496" }, "billing_address": { "country": "MX", "state": "DIF", "street": "street_2", "number": "12", "interior_number": "", "zip": "07300", "suburb": "Ciudad de México", "city": "Ciudad de México", "latitude": "19.378359899999996", "longitude": "-99.1741468" } }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
company	object[]	An object containing the company data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "company": { "id": 1, "profile_id": "1", "folio": "1", "name": "Company 1", "billing_name": "Company 1", "rfc": "EEE1111HHH", "type_id": "1", "type": "Type 1", "industry_id": "1", "industry": "Industry 1", "website": "http://iiq.com", "phone": "5558889991", "billing_address": "address 1", "shipping_address": "address 2", "created_at": "19/01/2021", } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

UpdateCompany

Updates a Company

POST https://www.centiacrm.com/developers/api/v1/companies

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"UpdateCompany"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
centia_id	integer	The id of the company
name	string	The name of the Company
type_id	integer	The id of the company type
industry_id	integer	The id of the company industry
website optional	string	The website of the company
phone optional	string	The phone of the company
billing_name optional	string	The billing name of the company
rfc optional	string	The rfc of the company
shipping_address optional	object[]	An object containing the shipping address of the company
country	string	The country code. Obtained from the Profiles.GetCountries method
state	string	The state code. Obtained from the Profiles.GetStates method
street	string	The street address
number	string	The number of the house
interior_number	string	The interior number if any
zip	string	The zip code
suburb	string	The suburb if any
city	string	The city
latitude optional	string	The latitude coordinate
longitude optional	string	The longitude coordinate
billing_address optional	object[]	An object containing the billing address of the company
country	string	The country code. Obtained from the Profiles.GetCountries method
state	string	The state code. Obtained from the Profiles.GetStates method
street	string	The street address
number	string	The number of the house
interior_number	string	The interior number if any
zip	string	The zip code
suburb	string	The suburb if any
city	string	The city
latitude optional	string	The latitude coordinate
longitude optional	string	The longitude coordinate
inputs optional	object[]	Dynamic custom inputs for the company
input_id	integer	The id of the custom input
value	string	The value of the input

Request example

{
"method": "UpdateCompany",
"parameters": { "profile_id": 1, "centia_id": 1, "name": "Company 1 Updated", "type_id": 1, "industry_id": 1, "website": "http://iiq.com", "phone": "5558889991", "billing_name": "Company 1", "rfc": "EEE1111HHH", "shipping_address" : { "country": "MX", "state": "DIF", "street": "street_1", "number": "39", "interior_number": "", "zip": "07300", "suburb": "Ciudad de México", "city": "Ciudad de México", "latitude": "19.3472665", "longitude": "-99.0411496" }, "billing_address": { "country": "MX", "state": "DIF", "street": "street_2", "number": "12", "interior_number": "", "zip": "07300", "suburb": "Ciudad de México", "city": "Ciudad de México", "latitude": "19.378359899999996", "longitude": "-99.1741468" }, "inputs": [ { "input_id": 1, "value": "My custom value updated" } ] }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
company	object	An object containing the company data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "company": { "id": 1, "profile_id": "1", "folio": "1", "name": "Company 1 Updated", "billing_name": "Company 1", "rfc": "EEE1111HHH", "type_id": "1", "type": "Type 1", "industry_id": "1", "industry": "Industry 1", "website": "http://iiq.com", "phone": "5558889991", "billing_address": "address 1", "shipping_address": "address 2", "created_at": "19/01/2021", } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetCompany

Get a company by search

POST https://www.centiacrm.com/developers/api/v1/companies

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetCompany"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
search_by	string	The value type we are gonna use to search for the company. Supported options: 'id' or 'client_number'
search_value	string	The value that we are gonna use to search for our company

Request example

{
"method": "GetCompany",
"parameters": { "profile_id": 1, "search_by": "client_number", "search_value": "CLI00001" }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
company	object[]	Company object
error optional	string	Error message

Response success example

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetContacts

Gets a list of contacts for selected profile

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetContacts"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
company_id optional	integer	The id of the company
origin_id optional	array[]	An array of origin ids. Obtained from the Contacts.GetOrigins method
title_id optional	array[]	An array of title ids. Obtained from the Contacts.GetTitles method
position_id optional	array[]	An array of position ids. Obtained from the Contacts.GetPositions method
department_id optional	array[]	An array of department ids. Obtained from the Contacts.GetDepartments method
created_at optional	object[]	An object containing the creation date ranges
from optional	string	The min created at date of the company. Use format DD/MM/YY
to optional	string	The max created at date of the company. Use format DD/MM/YY
with_inputs optional	boolean	Indicates if we want to include input information for each company
with_addresses optional	boolean	Indicates if we want to include disclosed address information for each company
query optional	string	Search query string
pagination optional	integer	Number of items to paginate. Default is 500
page optional	integer	Add this if you want to start on a specific page

Request example

{
"method": "GetContacts",
"parameters": { "profile_id": 1, "company_id": 1, "origin_id": [1,2], "title_id": [1,2], "position_id": [1,2], "department_id": [1,2], "created_at": { "from": "01/01/2022", "to": "01/02/2022" }, "with_inputs": true, "query": null, "pagination": 15, "page": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
total	integer	Total number of opportunity objects
current_page	integer	Current results page of opportunity objects
last_page	integer	Last results page of opportunity objects
contacts	object[]	List of contact objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "total": 1, "current_page": 1, "last_page": 1, "contacts": [ { "id": 1, "profile_id": "1", "company_id": "1", "company_name": "Company 1", "name": "Joe", "surname": "Doe", "mother_surname": "Moe", "title_id": "1", "title": "Title 1", "origin_id": "1", "origin": "Origin 1", "position_id": "1", "position": Position 1, "department_id": "1", "department": Department 1, "email": "joe@test.com", "phone_office": "12341234", "phone_office_extension": "123", "phone_mobile": "12341234", "phone_other": "12341234", "skype": "joedoe", "linkedin": "http://"www.linkedin.com/in/joedoe", "twitter": joedoe, "billing_address": "address 1", "shipping_address": "address 2", "created_at": "19/01/2021", "assistant": { "name": "Asist", "surname": "Tant", "mother_surname": "One", "email": "asis@test.com", "phone_office": "12341234", "phone_office_extension": "123", "skype": asistont, "linkedin": "http://www.linkedin.com/in/asistont" }, "inputs": [ { "id": 1, "input_id": 2, "label": "Label", "value": "my value" } ] }, ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetOrigins

Gets a list of contact origins of selected profile

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetOrigins"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetOrigins",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
origins	object[]	List of origin objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "origins": [ { "id": 1, "profile_id": "1", "label": "Origin 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetTitles

Gets a list of titles of selected profile

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetTitles"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetTitles",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
titles	object[]	List of title objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "titles": [ { "id": 1, "profile_id": "1", "label": "Title 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetDepartments

Gets a list of departments of selected profile

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetDepartments"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetDepartments",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
departments	object[]	List of department objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "departments": [ { "id": 1, "profile_id": "1", "label": "Department 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetPositions

Gets a list of positions of selected profile

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetPositions"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetPositions",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
positions	object[]	List of position objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "positions": [ { "id": 1, "profile_id": "1", "label": "Position 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetInputs

Gets a list of contact inputs of selected profile

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetInputs"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetInputs",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
inputs	object[]	List of input objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "inputs": [ { "id": 1, "profile_id": "1", "label": "Input 1", "description": "My description", "type": "radio", "options": [ "option 1", "option 2" ] } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

CreateContact

Creates a Contact

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"CreateContact"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
company_id	integer	The id of the company this contact belongs to
name	string	The name of the Contact
surname	string	The surname of the Contact
mother_surname optional	string	The mother surname of the Contact
title_id optional	integer	The id of the contact title
origin_id	integer	The id of the contact origin
position_id optional	integer	The id of the contact position
department_id optional	integer	The id of the contact department
phone_office optional	string	The phone of the contact's office
phone_office_extension optional	string	The phone extension of the contact's office
phone_mobile optional	string	The mobile phone of the contact
phone_other optional	string	Another phone of the contact
email optional	string	The email of the contact
skype optional	string	The skype of the contact
linkedin optional	string	The linkedin of the contact
twitter optional	string	The twitter of the contact
shipping_address optional	object[]	An object containing the shipping address of the contact
country	string	The country code. Obtained from the Profiles.GetCountries method
state	string	The state code. Obtained from the Profiles.GetStates method
street	string	The street address
number	string	The number of the house
interior_number	string	The interior number if any
zip	string	The zip code
suburb	string	The suburb if any
city	string	The city
latitude optional	string	The latitude coordinate
longitude optional	string	The longitude coordinate
billing_address optional	object[]	An object containing the billing address of the contact
country	string	The country code. Obtained from the Profiles.GetCountries method
state	string	The state code. Obtained from the Profiles.GetStates method
street	string	The street address
number	string	The number of the house
interior_number	string	The interior number if any
zip	string	The zip code
suburb	string	The suburb if any
city	string	The city
latitude optional	string	The latitude coordinate
longitude optional	string	The longitude coordinate
assistant optional	object[]	An object containing the contact's assistant information
name	string	The assistant's name
surname	string	The assistant's surname
mother_surname optional	string	The assistant's mother surname
phone_office optional	string	The office phone number
phone_office_extension optional	string	The office phone number extension if any
email optional	string	The email
skype optional	string	The skype account
linkedin optional	string	The linkedin account

Request example

{
"method": "CreateContact",
"parameters": { "profile_id": 1, "company_id": 1, "name": "Joe", "surname": "Doe", "mother_surname": "Moe", "title_id": 1, "origin_id": 1, "position_id": 1, "department_id": 1, "phone_office": "5554564661", "phone_office_extension": "123", "phone_mobile": "5554564661", "phone_other": "5554564661", "email": "contact@test.com", "skype": "joedoe", "linkedin": "www.linkedin.com/in/joedoe", "twitter": "joedoe", "shipping_address": { "country": "MX", "state": "DIF", "street": "street_1", "number": "39", "interior_number": "", "zip": "07300", "suburb": "Ciudad de México", "city": "Ciudad de México", "latitude": "19.3472665", "longitude": "-99.0411496" }, "billing_address": { "country": "MX", "state": "DIF", "street": "street_2", "number": "12", "interior_number": "", "zip": "07300", "suburb": "Ciudad de México", "city": "Ciudad de México", "latitude": "19.378359899999996", "longitude": "-99.1741468" }, "assistant": { "name": "Asist", "surname": "Tant", "mother_surname": "One", "phone_office": "12341234", "phone_office_extension": "123", "email": "asist@test.com", "skype": "asistont", "linkedin": "www.linkedin.com/in/asistont" } }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
contact	object[]	An object containing the contact data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "contact": { "id": 1, "profile_id": "1", "company_id": "1", "company_name": "Company 1", "name": "Joe", "surname": "Doe", "mother_surname": "Moe", "title_id": "1", "title": "Title 1", "origin_id": "1", "origin": "Origin 1", "position_id": "1", "position": Position 1, "department_id": "1", "department": Department 1, "email": "joe@test.com", "phone_office": "12341234", "phone_office_extension": "123", "phone_mobile": "12341234", "phone_other": "12341234", "skype": "joedoe", "linkedin": "http://"www.linkedin.com/in/joedoe", "twitter": "joedoe", "billing_address": "address 1", "shipping_address": "address 2", "created_at": "19/01/2021", "assistant": { "name": "Asist", "surname": "Tant", "mother_surname": "One", "email": "asis@test.com", "phone_office": "12341234", "phone_office_extension": "123", "skype": "asistont", "linkedin": "http://www.linkedin.com/in/asistont" } } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

UpdateContact

Updates a Contact

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"UpdateContact"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
contact_id	integer	The id of the contact to update
name	string	The name of the Contact
surname	string	The surname of the Contact
mother_surname optional	string	The mother surname of the Contact
title optional	string	The string label of the contact title
title_id optional	integer	The id of the contact title
origin optional	string	The string label of the contact origin
origin_id optional	integer	The id of the contact origin
position optional	string	The string label of the contact position
position_id optional	integer	The id of the contact position
department optional	string	The string label of the contact department
department_id optional	integer	The id of the contact department
phone_office optional	string	The phone of the contact's office
phone_office_extension optional	string	The phone extension of the contact's office
phone_mobile optional	string	The mobile phone of the contact
phone_other optional	string	Another phone of the contact
email optional	string	The email of the contact
skype optional	string	The skype of the contact
linkedin optional	string	The linkedin of the contact
twitter optional	string	The twitter of the contact
shipping_address optional	object[]	An object containing the shipping address of the contact
country	string	The country code. Obtained from the Profiles.GetCountries method
state	string	The state code. Obtained from the Profiles.GetStates method
street	string	The street address
number	string	The number of the house
interior_number	string	The interior number if any
zip	string	The zip code
suburb	string	The suburb if any
city	string	The city
latitude optional	string	The latitude coordinate
longitude optional	string	The longitude coordinate
billing_address optional	object[]	An object containing the billing address of the contact
country	string	The country code. Obtained from the Profiles.GetCountries method
state	string	The state code. Obtained from the Profiles.GetStates method
street	string	The street address
number	string	The number of the house
interior_number	string	The interior number if any
zip	string	The zip code
suburb	string	The suburb if any
city	string	The city
latitude optional	string	The latitude coordinate
longitude optional	string	The longitude coordinate
assistant optional	object[]	An object containing the contact's assistant information
name	string	The assistant's name
surname	string	The assistant's surname
mother_surname optional	string	The assistant's mother surname
phone_office optional	string	The office phone number
phone_office_extension optional	string	The office phone number extension if any
email optional	string	The email
skype optional	string	The skype account
linkedin optional	string	The linkedin account
inputs optional	object[]	Dynamic custom inputs for the contact
input_id	integer	The id of the custom input
value	string	The value of the input

Request example

{
"method": "UpdateContact",
"parameters": { "profile_id": 1, "contact_id": 1, "name": "Joe Updated", "surname": "Doe", "mother_surname": "Moe", "title_id": 1, "origin_id": 1, "position_id": 1, "department_id": 1, "phone_office": "5554564661", "phone_office_extension": "123", "phone_mobile": "5554564661", "phone_other": "5554564661", "email": "contact@test.com", "skype": "joedoe", "linkedin": "www.linkedin.com/in/joedoe", "twitter": "joedoe", "shipping_address": { "country": "MX", "state": "DIF", "street": "street_1", "number": "39", "interior_number": "", "zip": "07300", "suburb": "Ciudad de México", "city": "Ciudad de México", "latitude": "19.3472665", "longitude": "-99.0411496" }, "billing_address": { "country": "MX", "state": "DIF", "street": "street_2", "number": "12", "interior_number": "", "zip": "07300", "suburb": "Ciudad de México", "city": "Ciudad de México", "latitude": "19.378359899999996", "longitude": "-99.1741468" }, "assistant": { "name": "Asist Update", "surname": "Tant", "mother_surname": "One", "email": "asis@test.com", "phone_office": "12341234", "phone_office_extension": "123", "skype": "asistont", "linkedin": "http://www.linkedin.com/in/asistont" }, "inputs": [ { "input_id": 1, "value": "My custom value" } ] }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
contact	object	An object containing the updated contact data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "contact": { "id": 1, "profile_id": "1", "company_id": "1", "company_name": "Company 1", "name": "Joe Updated", "surname": "Doe", "mother_surname": "Moe", "title_id": "1", "title": "Title 1", "origin_id": "1", "origin": "Origin 1", "position_id": "1", "position": "Position 1", "department_id": "1", "department": "Department 1", "email": "contact@test.com", "phone_office": "5554564661", "phone_office_extension": "123", "phone_mobile": "5554564661", "phone_other": "5554564661", "skype": "joedoe", "linkedin": "www.linkedin.com/in/joedoe", "twitter": "joedoe", "billing_address": "address 1", "shipping_address": "address 2", "assistant": { "name": "Asist Update", "surname": "Tant", "mother_surname": "One", "email": "asis@test.com", "phone_office": "12341234", "phone_office_extension": "123", "skype": "asistont", "linkedin": "http://www.linkedin.com/in/asistont" } } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

DeleteContact

Deletes a Contact

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"DeleteContact"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
contact_id	integer	The id of the contact to delete

Request example

{
"method": "DeleteContact",
"parameters": { "profile_id": 1, "contact_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
message	string	Success message
profile_id	integer	The id of the profile
contact_id	integer	The id of the deleted contact
error optional	string	Error message

Response success example

{
"success": true,
"response": { "message": "Contact deleted", "profile_id": 1, "contact_id": 1 }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetContact

Gets a contact by search

POST https://www.centiacrm.com/developers/api/v1/contacts

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetContact"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
company_id optional	integer	The id of the company
search_by	string	The value type we are gonna use to search for the contact. Supported options: 'id' or 'email'
search_value	string	The value that we are gonna use to search for our contact

Request example

{
"method": "GetContact",
"parameters": { "profile_id": 1, "company_id": 1, "search_by": "email", "search_value": "contact@test.com" }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
contact	object[]	An object containing the contact data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "contact": { "id": 1, "profile_id": "1", "company_id": "1", "company_name": "Company 1", "name": "Joe", "surname": "Doe", "mother_surname": "Moe", "title_id": "1", "title": "Title 1", "origin_id": "1", "origin": "Origin 1", "position_id": "1", "position": Position 1, "department_id": "1", "department": Department 1, "email": "joe@test.com", "phone_office": "12341234", "phone_office_extension": "123", "phone_mobile": "12341234", "phone_other": "12341234", "skype": "joedoe", "linkedin": "http://"www.linkedin.com/in/joedoe", "twitter": joedoe, "billing_address": "address 1", "shipping_address": "address 2", "created_at": "19/01/2021", "assistant": { "name": "Asist", "surname": "Tant", "mother_surname": "One", "email": "asis@test.com", "phone_office": "12341234", "phone_office_extension": "123", "skype": asistont, "linkedin": "http://www.linkedin.com/in/asistont" } } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetProducts

Gets a list of products

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetProducts"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
with_inputs optional	boolean	Indicates if we want to include input information for each product

Request example

{
"method": "GetProducts",
"parameters": { "profile_id": 1, "with_inputs": true }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
products	object[]	List of product objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "products": [ { "id": 1, "profile_id": 1, "name": "Product 1", "short_name": "prod1", "sku": "123456prod", "description": "this is a description", "value": 1000, "taxes": [ { "id": 1, "label": "Tax name", "value": "16" } ], "validity": { "id": 97, "label": "Validity name", "starts_at": "2022-10-19", "ends_at": "2022-11-19" }, "discount": { "id": 33, "label": "Discount name", "value": "10" }, "measure": { "id": 65, "label": "Measure name" }, "category": { "id": 65, "label": "Category name" }, "currency": { "id": 9, "label": "Peso mexicano", "symbol": "$", "code_iso": "MXN", "active": "1", "type_change": "1" }, "inputs": [ { "id": 74, "input_id": 24, "label": "tipo", "value": "valor" } ] } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetCategories

Gets a list of categories

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetCategories"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetCategories",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
categories	object[]	List of category objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "categories": [ { "id": 1, "label": "Category1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetValidities

Gets a list of validities

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetValidities"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetValidities",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
validities	object[]	List of validity objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "validities": [ { "id": 1, "label": "Validity1", "starts_at": "2023-07-13", "ends_at": "2023-12-28" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetDiscounts

Gets a list of discounts

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetDiscounts"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetDiscounts",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
discounts	object[]	List of discount objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "discounts": [ { "id": 1, "label": "Discount1", "value": "8" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetMeasures

Gets a list of measures

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetMeasures"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetMeasures",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
measures	object[]	List of measure objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "measures": [ { "id": 1, "label": "Measure1", } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetTaxes

Gets a list of taxes

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetTaxes"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetTaxes",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
taxes	object[]	List of tax objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "taxes": [ { "id": 1, "label": "Tax1", "value": "16" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetInputs

Gets a list of inputs

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetInputs"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetInputs",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
inputs	object[]	List of input objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "inputs": [ { "id": 123, "profile_id": 1, "label": "input1", "slug: "input_1", "description": "this is a description", "type": "text" }, { "id": 32, "profile_id": 1, "label": "input select", "slug": "input_select", "description": null, "type": "select", "options": [ "alfa", "beta", "gamma" ] } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

CreateProduct

Creates a Product

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"CreateProduct"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
name	string	The name of the product
short_name optional	string	The short name of the product
value	float	The value of the product
sku optional	string	The sku of the product
description optional	string	The description of the product
profile_currency_type_id optional	string	The id of the currency type
product_discount_id optional	string	The id of the discount
product_validity_id optional	string	The id of the validity
product_measury_id optional	string	The id of the measury
product_category_id optional	string	The id of the category
taxes optional	array	An array of ids for the taxes
inputs optional	object[]	An object containing the values of the inputs in key: value format where the key is the slug of the input and the value is the value of the input

Request example

{
"method": "CreateProduct",
"parameters": { "profile_id": 1, "name": "Product1", "short_name": "tstp1", "value": 2500, "sku": "testprod123", "description": "This is a description", "profile_currency_type_id": 1, "product_discount_id": 1, "product_validity_id": 1, "product_measury_id": 1, "product_category_id": 1, "taxes": [1, 2], "inputs": { "test_select": "gamma", "test_text": "value1" } }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
product	object[]	An object containing the product data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "product": { "id": 4, "profile_id": 1, "name": "Product1", "short_name": "tstp1", "sku": "testprod123", "description": "This is a description", "value": 2500, "taxes": [ { "id": 1, "label": "IVA", "value": "16" }, { "id": 2, "label": "ISR", "value": "10" } ], "validity": { "id": 1, "label": "Dic2023", "starts_at": "2023-12-01", "ends_at": "2023-12-31" }, "discount": { "id": 1, "label": "Xmas", "value": "15" }, "measure": { "id": 1, "label": "Piece" }, "category": { "id": 1, "label": "recicled" }, "currency": { "id": 1, "label": "Dólar americano", "symbol": "$", "code_iso": "USD", "active": "1", "type_change": "1" }, "inputs": [ { "id": 1, "input_id": 3231, "label": "test select", "value": "gamma" }, { "id": 2, "input_id": 3707, "label": "test text", "value": "value1" } ] } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

EditProduct

Edits a Product

POST https://www.centiacrm.com/developers/api/v1/products

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"EditProduct"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
product_id	integer	The id of the product
name	string	The name of the product
short_name optional	string	The short name of the product
value	float	The value of the product
sku optional	string	The sku of the product
description optional	string	The description of the product
profile_currency_type_id optional	string	The id of the currency type
product_discount_id optional	string	The id of the discount
product_validity_id optional	string	The id of the validity
product_measury_id optional	string	The id of the measury
product_category_id optional	string	The id of the category
taxes optional	array	An array of ids for the taxes
inputs optional	object[]	An object containing the values of the inputs in key: value format where the key is the slug of the input and the value is the value of the input

Request example

{
"method": "EditProduct",
"parameters": { "profile_id": 1, "product_id": 1, "name": "Product1", "short_name": "tstp1", "value": 2500, "sku": "testprod123", "description": "This is a description", "profile_currency_type_id": 1, "product_discount_id": 1, "product_validity_id": 1, "product_measury_id": 1, "product_category_id": 1, "taxes": [1, 2], "inputs": { "test_select": "gamma", "test_text": "value1" } }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
product	object[]	An object containing the product data
error optional	string	Error message

Response success example

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetInputs

Gets a list of opportunity inputs of selected profile

POST https://www.centiacrm.com/developers/api/v1/opportunities

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetInputs"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetInputs",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
inputs	object[]	List of input objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "inputs": [ { "id": 1, "profile_id": "1", "label": "Input 1", "description": "My description", "type": "radio", "options": [ "option 1", "option 2" ] } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetOpportunities

Gets a list of opportunities for selected profile

POST https://www.centiacrm.com/developers/api/v1/opportunities

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetOpportunities"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
user_id optional	integer	The id of the user
status optional	string	The status of the opportunity. Supported options: 'active', 'pending', 'won' or 'lost'
contact_type optional	string	The contact type of the opportunity. Supported options: 'new' or 'existing'
operation_type optional	string	The operation type of the opportunity. Supported options: 'new' or 'renew'
stage optional	array[]	An array of stage ids. . Obtained from the Profiles.GetStages method
contact_origin optional	array[]	An array of contat_origin ids. Obtained from the Contacts.GetOrigins method
company_industry optional	array[]	An array of company_industry ids. Obtained from the Companies.GetIndustries method
value optional	object[]	An object containing the value ranges
from optional	string	The min value of the opportunity
to optional	string	The max value of the opportunity
created_at optional	object[]	An object containing the creation date ranges
from optional	string	The min created at date of the opportunity. Use format DD/MM/YY
to optional	string	The max created at date of the opportunity. Use format DD/MM/YY
estimated_end_at optional	object[]	An object containing the estimated end date ranges
from optional	string	The min estimated end date of the opportunity. Use format DD/MM/YY
to optional	string	The max estimated end date of the opportunity. Use format DD/MM/YY
closed_at optional	object[]	An object containing the closed at date ranges
from optional	string	The min closed at date of the opportunity. Use format DD/MM/YY
to optional	string	The max closed at date of the opportunity. Use format DD/MM/YY
with_user optional	boolean	Indicates if we want to include user information for each opportunity
with_company optional	boolean	Indicates if we want to include company information for each opportunity
with_contact optional	boolean	Indicates if we want to include contact information for each opportunity
with_products optional	boolean	Indicates if we want to include product information for each opportunity
with_inputs optional	boolean	Indicates if we want to include input information for each opportunity
query optional	string	Search query string
pagination optional	integer	Number of items to paginate. Default is 500
page optional	integer	Add this if you want to start on a specific page

Request example

{
"method": "GetOpportunities",
"parameters": { "profile_id": 1, "user_id": 1, "status": "active", "contact_type": "existing", "operation_type": "new", "contact_origin": [1,2,3], "company_industry": [1,2], "stage": [1], "value": { "from": "0.00", "to": "1000.00" }, "created_at": { "from": "01/01/2021", "to": "01/01/2022" }, "estimated_end_at": { "from": null, "to": null }, "closed_at": { "from": null, "to": null }, "with_user": false, "with_company": false, "with_contact": false, "with_products": true, "with_inputs": true, "query": null, "pagination": 15, "page": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
total	integer	Total number of opportunity objects
current_page	integer	Current results page of opportunity objects
last_page	integer	Last results page of opportunity objects
opportunities	object[]	List of opportunity objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "total": 1, "current_page": 1, "last_page": 1, "opportunities": [ { "id": 1, "profile_id": 1, "company_id": 1, "contact_id": 1, "user_id": 1, "folio": "1", "title": "My title", "value": "1000.00", "prospect_type": "new", "operation_type": "new", "stage_id": 1, "created_at": "26/06/2022", "estimated_end_at": "26/06/2022", "closed_at": "26/06/2022", "products": [ { "id": "1", "name": "Product 1", "sku": "product1", "description": "My description", "amount": "1", "price": "1000", "discount": "0", "tax": "0.16", "tax_total": "160", "total": "1000", "total_with_tax": "1160" } ], "inputs": [ { "id": 1, "input_id": 1, "label": "Label", "value": "my value" }, ] } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

CreateOpportunity

Creates an Opportunity

POST https://www.centiacrm.com/developers/api/v1/opportunities

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"CreateOpportunity"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
user_id	integer	The id of the user that will own the opportunity
title	string	The title of the opportunity
value	float	The value of the opportunity
estimated_end_at	string	The estimated end date of the opportunity. Use format DD/MM/YY
prospect_type	string	The prospect type of the opportunity. Supported options: 'new' or 'existing'
operation_type	string	The operation type of the opportunity. Supported options: 'new' or 'renew'
stage_id	integer	The id of the stage the opportunity will be created at
company_id	integer	The id of the company the opportunity will be created for. The company must belong to the profile selected. If you want to create an opportunity for an individual use the value "is_individual_fixed"
contact_id	integer	The id of the contact the opportunity will be created for. The contact must belong to the company selected
campaign_id optional	string	The id of the campaign the opportunity will be created for
want_products	boolean	Indicates if the opportunity has products or not
want_tax	boolean	Indicates if the opportunity products will have tax or not
products optional	object[]	An object containing the information of the products
product_id	integer	The id of the product
amount	integer	The amount of products that the opportunity contains
price	float	The price for each unit of the product
discount	float	The discount applied for each product
tax	float	Amount or percentage of the tax applied to the product. from 0.00 to 1.00
total	float	The total amount for this product
notify	boolean	Indicates if we want a notification to be sent to the user
comment optional	string	The comment that will be sent on the notification
status optional	string	If the opportunity is already won upon creation, set this to 'won'
won_at optional	string	If status is won, the date when the opportunity was won. Use format DD/MM/YYYY hh:mm A
inputs optional	object[]	Dynamic custom inputs for the opportunity
input_id	integer	The id of the custom input
value	string	The value of the input

Request example

{
"method": "CreateOpportunity",
"parameters": { "profile_id": 1, "user_id": 1, "title": "My title", "value": 1000, "estimated_end_at": "17/10/2021", "prospect_type": "new", "operation_type": "new", "stage_id": 1, "company_id": 1, "contact_id": 1, "campaign_id" : "ab027674-6483-43d7-aac1-a86f6d3c68b2", "want_products": true, "want_tax": true, "products": [ { "product_id": 1, "amount": 1, "price": 1000.6, "discount": 10, "tax": 0.16, "total": 1044.63 } ], "notify": true, "comment" : "This is a comment", "status": "won", "won_at": "17/10/2021 11:30 AM", "inputs": [ { "input_id": 1, "value": "My custom value" } ] }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
opportunity	object[]	An object containing the opportunity data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "opportunity": [ { "id": 1, "profile_id": 1, "company_id": 1, "contact_id": 1, "user_id": 1, "folio": "1", "campaign_id" : "ab027674-6483-43d7-aac1-a86f6d3c68b2", "title": "My title", "value": "1000.00", "prospect_type": "new", "operation_type": "new", "stage_id": 1, "created_at": "26/06/2022", "estimated_end_at": "26/06/2022", "closed_at": "26/06/2022", } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetOpportunity

Gets an opportunity

POST https://www.centiacrm.com/developers/api/v1/opportunities

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetOpportunity"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
opportunity_id	integer	The id of the opportunity
with_user optional	boolean	Indicates if we want to include user information
with_company optional	boolean	Indicates if we want to include company information
with_contact optional	boolean	Indicates if we want to include contact information
with_products optional	boolean	Indicates if we want to include product information
with_inputs optional	boolean	Indicates if we want to include input information

Request example

{
"method": "GetOpportunity",
"parameters": { "profile_id": 1, "opportunity_id": 1, "with_user": false, "with_company": false, "with_contact": false, "with_products": true, "with_inputs": true }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
opportunity	object[]	Opportunity object
error optional	string	Error message

Response success example

{
"success": true,
"response": { "opportunity": { "id": 1, "profile_id": 1, "company_id": 1, "contact_id": 1, "user_id": 1, "folio": "1", "title": "My title", "value": "1000.00", "prospect_type": "new", "operation_type": "new", "stage_id": 1, "created_at": "26/06/2022", "estimated_end_at": "26/06/2022", "closed_at": "26/06/2022", "products": [ { "id": "1", "name": "Product 1", "sku": "product1", "description": "My description", "amount": "1", "price": "1000", "discount": "0", "tax": "0.16", "tax_total": "160", "total": "1000", "total_with_tax": "1160" } ], "inputs": [ { "id": 1, "input_id": 1, "label": "Label", "value": "my value" }, ] } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

EditOpportunity

Edits an Opportunity

POST https://www.centiacrm.com/developers/api/v1/opportunities

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"EditOpportunity"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
opportunity_id	integer	The id of the opportunity to edit
user_id	integer	The id of the user that will own the opportunity
title	string	The title of the opportunity
value	float	The value of the opportunity
estimated_end_at	string	The estimated end date of the opportunity. Use format DD/MM/YY
prospect_type	string	The prospect type of the opportunity. Supported options: 'new' or 'existing'
operation_type	string	The operation type of the opportunity. Supported options: 'new' or 'renew'
stage_id	integer	The id of the stage the opportunity will be created at
company_id	integer	The id of the company the opportunity belongs to.
contact_id	integer	The id of the contact the opportunity belongs to.
campaign_id optional	string	The id of the campaign the opportunity will be created for
want_products	boolean	Indicates if the opportunity has products or not
want_tax	boolean	Indicates if the opportunity products will have tax or not
products optional	object[]	An object containing the information of the products
product_id	integer	The id of the product
amount	integer	The amount of products that the opportunity contains
price	float	The price for each unit of the product

Request example

{
"method": "EditOpportunity",
"parameters": { "profile_id": 1, "opportunity_id": 1, "user_id": 1, "title": "My title", "value": 1000, "estimated_end_at": "17/10/2021", "prospect_type": "new", "operation_type": "new", "stage_id": 1, "company_id": 1, "contact_id": 1, "campaign_id" : "ab027674-6483-43d7-aac1-a86f6d3c68b2", "want_products": true, "want_tax": true, "products": [ { "product_id": 1, "amount": 1, "price": 1000.6, "is_collapse": false } ] }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
opportunity	object	An object containing the edited opportunity data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "opportunity": { "id": 1, "profile_id": 1, "company_id": 1, "contact_id": 1, "user_id": 1, "folio": "1", "campaign_id" : "ab027674-6483-43d7-aac1-a86f6d3c68b2", "title": "My title", "value": "1000.00", "prospect_type": "new", "operation_type": "new", "stage_id": 1, "created_at": "26/06/2022", "estimated_end_at": "26/06/2022", "closed_at": "26/06/2022" } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

DeleteOpportunity

Deletes an opportunity

POST https://www.centiacrm.com/developers/api/v1/opportunities

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"DeleteOpportunity"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
opportunity_id	integer	The id of the opportunity

Request example

{
"method": "DeleteOpportunity",
"parameters": { "profile_id": 1, "opportunity_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
opportunity	object	Deleted opportunity object
error optional	string	Error message

Response success example

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

ChangeOpportunityOwner

Moves the opportunity to a new owner

POST https://www.centiacrm.com/developers/api/v1/opportunities

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"ChangeOpportunityOwner"
parameters	object[]	An object with data for the method
user_id	integer	The id of the user that will be the new owner
opportunity_id	integer	The id of the opportunity to transfer
comment optional	string	A given comment to attach to the transfer

Request example

{
"method": "ChangeOpportunityOwner",
"parameters": { "user_id": 2, "opportunity_id": 1, "comment": "Transferring opportunity" }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
owner	object	An object containing the user owner information
error optional	string	Error message

Response success example

{
"success": true,
"response": { "owner": { "id": 2, "name": "John Doe", "email": "johndoe@example.com" } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

AddNoteToOpportunity

Adds a note to the opportunity

POST https://www.centiacrm.com/developers/api/v1/opportunities

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"AddNoteToOpportunity"
parameters	object[]	An object with data for the method
opportunity_id	integer	The id of the opportunity
note	string	The content of the note
mentions optional	array[]	Array of user IDs mentioned in the note

Request example

{
"method": "AddNoteToOpportunity",
"parameters": { "opportunity_id": 1, "note": "Calling client to secure deal", "mentions": [2, 3] }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
activity	object	An object containing the created note activity data
status	string	Status string e.g. "success"
error optional	string	Error message

Response success example

{
"success": true,
"response": { "activity": { "id": 1, "type_id": 2, "opportunity_id": 1, "details": "Calling client to secure deal", "user_id": 1, "company_id": 1 }, "status": "success" }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetTickets

Gets a list of tickets for selected profile

POST https://www.centiacrm.com/developers/api/v1/tickets

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetTickets"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetTickets",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
tickets	object[]	List of tickets objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "tickets": [ { "id": 1, "profile_id": 1, "company_id": 1, "contact_id": 1, "folio": "00001", "title": "Example", "description": "Example", "manager_id": 1, "status": "abierto", "opportunity_id": 1, "origin_id": 1, "case_id": 1, "priority_id": 1, "estimated_end_at": "0000-00-00 00:00:00", }, ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetOrigins

Gets a list of tickets origins of selected profile

POST https://www.centiacrm.com/developers/api/v1/tickets

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetOrigins"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetOrigins",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
origins	object[]	List of origin objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "origins": [ { "id": 1, "description": "Origin 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetCases

Gets a list of tickets cases of selected profile

POST https://www.centiacrm.com/developers/api/v1/tickets

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetCases"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetCases",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
cases	object[]	List of cases objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "cases": [ { "id": 1, "description": "Case 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

GetPriorities

Gets a list of tickets priorities of selected profile

POST https://www.centiacrm.com/developers/api/v1/tickets

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"GetPriorities"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile

Request example

{
"method": "GetPriorities",
"parameters": { "profile_id": 1 }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
priorities	object[]	List of priorities objects
error optional	string	Error message

Response success example

{
"success": true,
"response": { "priorities": [ { "id": 1, "description": "Priority 1" } ] }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}

CreateTicket

Creates a ticket

POST https://www.centiacrm.com/developers/api/v1/tickets

Header

Field	Type	Description
Authorization	string	"Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field	Type	Description
method	string	"CreateTicket"
parameters	object[]	An object with data for the method
profile_id	integer	The id of the profile
title	string	The title of the ticket
description	string	The description of the ticket
company_id	integer	The id of the company the ticket will be created for
contact_id optional	integer	The id of the contact the ticket will be created for. The contact must belong to the company selected
opportunity_id optional	integer	The id of the opportunity linked to the ticket
user_id	integer	The id of the user that will own the ticket
origin_id	integer	The id of the ticket origin
case_id	integer	The id of the ticket case
priority_id	integer	The id of the ticket priority
estimated_end_at	string	The estimated end date of the ticket. Use format YYYY-MM-DD
notify	boolean	Indicates if we want a notification to be sent to the user
comment optional	string	The comment that will be sent on the notification

Request example

{
"method": "createTicket",
"parameters": { "profile_id": 1, "title": "My title", "description": "Lorem ipsum dolor sit amet", "company_id": 1, "opportunity_id": 1, "user_id": 1, "origin_id": 1, "case_id": 1, "priority_id": 1, "estimated_end_at": "0000-00-00", "notify": true, "comment": "test comment" }
}

Response

Field	Type	Description
success	boolean	Indicates if successfull
response	object[]	An object containing the response data
ticket	object[]	An object containing the ticket data
error optional	string	Error message

Response success example

{
"success": true,
"response": { "ticket": { "id": 1, "profile_id": 1, "company_id": 1, "contact_id": 1, "folio": "00001", "title": "My title", "description": "Lorem ipsum dolor sit amet", "manager_id": 1, "status": "abierto", "opportunity_id": 1, "origin_id": 1, "case_id": 1, "priority_id": 1, "estimated_end_at": "0000-00-00 00:00:00" } }
}

Response error example

{
"success": false,
"response": null,
"error": "Required parameters missing"
}