Empieza gratis
Iniciar sesión

Salesly.app API

Documentation version 1.0

https://rest.salesly.app/api/developers/v1/

Description

Manage your principal Salesly modules.The API key is achieved within the Salesly.app. You can find it inside Salesly.app Config, Api module. All request tests will take effect in your Salesly.app account. So take care.

Api Base URL

https://rest.salesly.app/api/developers/v1/{request path}

Headers requireds

All request need a couple of headers: x-api-key: (Copy from Salesly.app config) Accept: application/json

Enterprises

/enterprises/create

 POST

/enterprises/multiple_create

 POST

/enterprises/read/{id}

 GET

/enterprises/edit

 PUT

/enterprises/delete

 DELETE

/enterprises/list

 POST

Headers

  • x-api-key: required(string)
  • Accept: required(string – default: application/json)

Body

Media type: application/json

Type: object

Properties

  • name: required(string)
  • type: required(integer)
  • email: required(string)
  • cif: (string)
  • phone: (string)
  • phone2: (string)
  • web: (string)
  • iban: (string)
  • public: (boolean)
  • users: (array of any)Array of Users ids
  • location: (object)
    • primary: required(integer)
    • direction: required(string)
    • city: required(string)
    • postal: required(string)
    • country: required(string)
    • latitude: (string)
    • longitude: (string)
    • extra_info: (string)
  • extra_fields: (object)
    • contacts_ids: (array of any)Array of Contacts ids
    • contacts: (array of ContactTypes.Contact)Items: Contact
    • name: required(string)
    • surname: required(string)
    • surname2: (string)
    • email: required(string)
    • phone: (string)
    • phone2: (string)
    • position: (string)
    • skype: (string)
    • linkedin: (string)
    • comments: (string)
    • gender: (boolean)
    • enterprise_id: required(integer)
    		 
    Example:
[object Object]

Example:
{
"name": "Salesly.app",
"email": "info@salesly.app",
"comments": null,
"cif": "G123456789",
"phone": "938206362",
"phone_2": null,
"iban": null,
"web": null,
"public": 0,
"last_event": null,
"next_event": null,
"last_opportunity_sale_date": null,
"state": 0,
"type": 1,
"no_user": 0,
"extra_field": null,
"contacted": null,
"mailchimp_unsubscribed": null,
"location": {
"primary": 1,
"direction": "Carrer Gavarresa",
"city": "Cabrianes",
"postal": "08620",
"country": "Spain",
"latitude": "41.7984089",
"longitude": "1.9100628999999572"
},
"contacts": [],
"users": []
}

     

    Headers

    • x-api-key: required(string)
    • Accept: required(string – default: application/json)

    Body

    Media type: application/json

    Type: object

    Properties

    • name: required(string)
    • type: required(integer)
    • email: required(string)
    • cif: (string)
    • phone: (string)
    • phone2: (string)
    • web: (string)
    • iban: (string)
    • public: (boolean)
    • users: (array of any)Array of Users ids
    • location: (object)
      • primary: required(integer)
      • direction: required(string)
      • city: required(string)
      • postal: required(string)
      • country: required(string)
      • latitude: (string)
      • longitude: (string)
      • extra_info: (string)
    • extra_fields: (object)
      • contacts_ids: (array of any)Array of Contacts ids
      • contacts: (array of ContactTypes.Contact)Items: Contact
      • name: required(string)
      • surname: required(string)
      • surname2: (string)
      • email: required(string)
      • phone: (string)
      • phone2: (string)
      • position: (string)
      • skype: (string)
      • linkedin: (string)
      • comments: (string)
      • gender: (boolean)
      • enterprise_id: required(integer)
      		 
      Example:
[object Object]

Example:
{
"name": "Salesly.app",
"email": "info@salesly.app",
"comments": null,
"cif": "G123456789",
"phone": "938206362",
"phone_2": null,
"iban": null,
"web": null,
"public": 0,
"last_event": null,
"next_event": null,
"last_opportunity_sale_date": null,
"state": 0,
"type": 1,
"no_user": 0,
"extra_field": null,
"contacted": null,
"mailchimp_unsubscribed": null,
"location": {
"primary": 1,
"direction": "Carrer Gavarresa",
"city": "Cabrianes",
"postal": "08620",
"country": "Spain",
"latitude": "41.7984089",
"longitude": "1.9100628999999572"
},
"contacts": [],
"users": []
}

       

      /enterprises/multiple_create

      Headers

      • x-api-key: required(string)
      • Accept: required(string – default: application/json)

      Body

      Media type: application/json

      Type: object

      Properties

      • data: required(array of EnterpriseTypes.EnterpriseCreate)50 objects maxItems: EnterpriseCreate
        • name: required(string)
        • type: required(integer)
        • email: required(string)
        • cif: (string)
        • phone: (string)
        • phone2: (string)
        • web: (string)
        • iban: (string)
        • public: (boolean)
        • users: (array of any)Array of Users ids
        • location: (object)
          • primary: required(integer)
          • direction: required(string)
          • city: required(string)
          • postal: required(string)
          • country: required(string)
          • latitude: (string)
          • longitude: (string)
          • extra_info: (string)
        • extra_fields: (object)
          • contacts_ids: (array of any)Array of Contacts ids
          • contacts: (array of ContactTypes.Contact)Items: Contact
            • name: required(string)
            • surname: required(string)
            • surname2: (string)
            • email: required(string)
            • phone: (string)
            • phone2: (string)
            • position: (string)
            • skype: (string)
            • linkedin: (string)
            • comments: (string)
            • gender: (boolean)
            • enterprise_id: required(integer)
        		 
        Example:
[object Object]

Example:
{
  "name": "Salesly.app",
  "email": "info@salesly.app",
  "comments": null,
  "cif": "G123456789",
  "phone": "938206362",
  "phone_2": null,
  "iban": null,
  "web": null,
  "public": 0,
  "last_event": null,
  "next_event": null,
  "last_opportunity_sale_date": null,
  "state": 0,
  "type": 1,
  "no_user": 0,
  "extra_field": null,
  "contacted": null,
  "mailchimp_unsubscribed": null,
  "location": {
    "primary": 1,
    "direction": "Carrer Gavarresa",
    "city": "Cabrianes",
    "postal": "08620",
    "country": "Spain",
    "latitude": "41.7984089",
    "longitude": "1.9100628999999572"
  },
  "contacts": [],
  "users": []
}

Example:

{
  "data" : [
    {
      "name": "Salesly.app",
      "email": "info@salesly.app",
      "comments": null,
      "cif": "G123456789",
      "phone": "938206362",
      "phone_2": null,
      "iban": null,
      "web": "https://www.salesly.app",
      "public": 0,
      "last_event": null,
      "next_event": null,
      "last_opportunity_sale_date": null,
      "state": 0,
      "type": 1,
      "no_user": 0,
      "extra_field": null,
      "contacted": null,
      "mailchimp_unsubscribed": null,
      "location": {
        "primary": 1,
        "direction": "Carrer Gavarresa",
        "city": "Cabrianes",
        "postal": "08620",
        "country": "Spain",
        "latitude": "41.7984089",
        "longitude": "1.9100628999999572"
      },
      "contacts": [],
      "users": []
    }
  ]
}

         

        Headers

        • x-api-key: required(string)
        • Accept: required(string – default: application/json)

        Body

        Media type: application/json

        Type: object

        Properties

        • name: required(string)
        • type: required(integer)
        • email: required(string)
        • cif: (string)
        • phone: (string)
        • phone2: (string)
        • web: (string)
        • iban: (string)
        • public: (boolean)
        • users: (array of any)Array of Users ids
        • location: (object)
          • primary: required(integer)
          • direction: required(string)
          • city: required(string)
          • postal: required(string)
          • country: required(string)
          • latitude: (string)
          • longitude: (string)
          • extra_info: (string)
        • extra_fields: (object)
          • contacts_ids: (array of any)Array of Contacts ids
          • contacts: (array of ContactTypes.Contact)Items: Contact
          • name: required(string)
          • surname: required(string)
          • surname2: (string)
          • email: required(string)
          • phone: (string)
          • phone2: (string)
          • position: (string)
          • skype: (string)
          • linkedin: (string)
          • comments: (string)
          • gender: (boolean)
          • enterprise_id: required(integer)
          		 
          Example:
[object Object]

Example:
{
"name": "Salesly.app",
"email": "info@salesly.app",
"comments": null,
"cif": "G123456789",
"phone": "938206362",
"phone_2": null,
"iban": null,
"web": null,
"public": 0,
"last_event": null,
"next_event": null,
"last_opportunity_sale_date": null,
"state": 0,
"type": 1,
"no_user": 0,
"extra_field": null,
"contacted": null,
"mailchimp_unsubscribed": null,
"location": {
"primary": 1,
"direction": "Carrer Gavarresa",
"city": "Cabrianes",
"postal": "08620",
"country": "Spain",
"latitude": "41.7984089",
"longitude": "1.9100628999999572"
},
"contacts": [],
"users": []
}