Deal Unqualified Reasons

The Deal Unqualified Reasons API provides a simple interface to manage deal unqualified reasons. The API allows you to create, delete and update unqualified reasons. You can retrieve a single unqualified reason as well as list of all reasons.

Properties

Attribute	Description
id number readonly	Unique identifier of the deal unqualified reason.
creator_id number readonly	Unique identifier of the user the deal unqualified reason was created by.
name string	Human-friendly unqualified reason explanation.
created_at string readonly	Date and time of creation in UTC ISO8601 format.
updated_at string readonly	Date and time of the last update in UTC ISO8601 format.

Retrieve all deal unqualified reasons

Returns all deal unqualified reasons available to the user according to the parameters provided.

Parameters

Attribute	Description
page number optional	Page number to start from. Page numbering is 1-based and omitting `page` parameter will return the first page. e.g. `?page=2`
per_page number optional	Number of records to return per page. Default limit is 25 and maximum number that can be returned is 100. e.g. `?per_page=20`
sort_by string optional	A field to sort by. Default ordering is ascending. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=name:desc`. Possible values: id name updated_at created_at e.g. `?sort_by=created_at`
ids string optional	Comma separated list of deal unqualified reasons unique identifiers to be returned in a request. e.g. `?ids=1,2,3`
name string optional	Name of the unqualified reason to search for. This parameter is used in a strict sense. e.g. `?name=Not%20budget`

Action

GET /v2/deal_unqualified_reasons

Examples

Retrieve all deal unqualified reasons

GET /v2/deal_unqualified_reasons HTTP/1.1

Accept: application/json
Authorization: Bearer $ACCESS_TOKEN

curl -v -X GET https://api.getbase.com/v2/deal_unqualified_reasons \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
response = RestClient.execute method: :get, url: "https://api.getbase.com/v2/deal_unqualified_reasons", headers: headers

puts response

import requests
import json

response = requests.get(
    url='https://api.getbase.com/v2/deal_unqualified_reasons',
    headers={
      'Accept': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "items": [
    {
      "data": {
        "id": 2871117,
        "created_at": "2016-08-30T15:04:32Z",
        "updated_at": "2016-08-30T15:04:32Z",
        "name": "No need",
        "creator_id": 911978
      },
      "meta": {
        "type": "deal_unqualified_reason"
      }
    },
    {
      "data": {
        "id": 2871118,
        "created_at": "2016-08-30T15:04:32Z",
        "updated_at": "2016-08-30T15:04:32Z",
        "name": "Not the decision maker",
        "creator_id": 911978
      },
      "meta": {
        "type": "deal_unqualified_reason"
      }
    }
  ],
  "meta": {
    "type": "collection",
    "count": 2,
    "links": {
      "self": "https://api.getbase.com/v2/deal_unqualified_reasons"
    }
  }
}

Create a deal unqualified reason

Create a new deal unqualified reason.

unqualified reason’s name must be unique.

Parameters

Attribute	Description
name string required	Must be unique. e.g. `"name": "Other"`

Action

POST /v2/deal_unqualified_reasons

Examples

Simple create

POST /v2/deal_unqualified_reasons HTTP/1.1

Accept: application/json
Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
  "data": {
    "name": "Other"
  },
  "meta": {
    "type": "deal_unqualified_reason"
  }
}

curl -v -X POST https://api.getbase.com/v2/deal_unqualified_reasons \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{
  "data": {
    "name": "Other"
  },
  "meta": {
    "type": "deal_unqualified_reason"
  }
}'

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
body = '{
"data": {
  "name": "Other"
},
"meta": {
  "type": "deal_unqualified_reason"
}
}
'
response = RestClient.execute method: :post, url: "https://api.getbase.com/v2/deal_unqualified_reasons", payload: body, headers: headers

puts response

import requests
import json

payload = {
  'data': {
    'name': 'Other'
  },
  'meta': {
    'type': 'deal_unqualified_reason'
  }
}

response = requests.post(
    url='https://api.getbase.com/v2/deal_unqualified_reasons',
    headers={
      'Accept': 'application/json',
      'Content-Type': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    data=json.dumps(payload),
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": 4,
    "creator_id": 1,
    "name": "Other",
    "created_at": "2014-08-27T16:33:00Z",
    "updated_at": "2014-08-27T16:33:00Z"
  },
  "meta": {
    "type": "deal_unqualified_reason"
  }
}

Retrieve a single deal unqualified reason

Returns a single unqualified reason available to the user by the provided id. If a unqualified reason with the supplied unique identifier does not exist, it returns an error.

Parameters

Attribute	Description
id number required	Unique identifier of the unqualified reason.

Action

GET /v2/deal_unqualified_reasons/:id

Examples

Retrieve a unqualified reason with id 4

GET /v2/deal_unqualified_reasons/4 HTTP/1.1

Accept: application/json
Authorization: Bearer $ACCESS_TOKEN

curl -v -X GET https://api.getbase.com/v2/deal_unqualified_reasons/4 \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
response = RestClient.execute method: :get, url: "https://api.getbase.com/v2/deal_unqualified_reasons/4", headers: headers

puts response

import requests
import json

response = requests.get(
    url='https://api.getbase.com/v2/deal_unqualified_reasons/4',
    headers={
      'Accept': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": 4,
    "creator_id": 1,
    "name": "Other",
    "created_at": "2014-08-27T16:33:00Z",
    "updated_at": "2014-08-27T16:33:00Z"
  },
  "meta": {
    "type": "deal_unqualified_reason"
  }
}

Update a deal unqualified reason

Updates a unqualified reason information. If the specified unqualified reason does not exist, the request will return an error.

If you want to update unqualified reason you must make sure name of the reason is unique.

Parameters

Attribute	Description
id number required	Unique identifier of the unqualified reason.
name string optional	Must be unique. e.g. `"name": "Not the right timing"`

Action

PUT /v2/deal_unqualified_reasons/:id

Examples

Update a unqualified reason with id 4

PUT /v2/deal_unqualified_reasons/4 HTTP/1.1

Accept: application/json
Content-Type: application/json
Authorization: Bearer $ACCESS_TOKEN

{
  "data": {
    "name": "Not the right timing"
  }
}

curl -v -X PUT https://api.getbase.com/v2/deal_unqualified_reasons/4 \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{
  "data": {
    "name": "Not the right timing"
  }
}'

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
body = '{
  "data": {
    "name": "Not the right timing"
  }
}

'
response = RestClient.execute method: :put, url: "https://api.getbase.com/v2/deal_unqualified_reasons/4", payload: body, headers: headers

puts response

import requests
import json

payload = {
  'data': {
    'name': 'Not the right timing'
  }
}

response = requests.put(
    url='https://api.getbase.com/v2/deal_unqualified_reasons/4',
    headers={
      'Accept': 'application/json',
      'Content-Type': 'application/json',
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    data=json.dumps(payload),
    verify=True
  )

print(response.text)

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8
Content-Language: en

{
  "data": {
    "id": 4,
    "creator_id": 1,
    "name": "Not the right timing",
    "created_at": "2014-08-27T16:33:00Z",
    "updated_at": "2014-08-27T16:33:01Z"
  },
  "meta": {
    "type": "deal_unqualified_reason"
  }
}

Delete a reason

Delete an existing unqualified reason. If the reason with supplied unique identifier does not exist it returns an error. This operation cannot be undone.

Parameters

Attribute	Description
id number required	Unique identifier of the unqualified reason.

Action

DELETE /v2/deal_unqualified_reasons/:id

Examples

Delete a unqualified reason with id 1

DELETE /v2/deal_unqualified_reasons/1 HTTP/1.1

Authorization: Bearer $ACCESS_TOKEN

curl -v -X DELETE https://api.getbase.com/v2/deal_unqualified_reasons/1 \
-H "Authorization: Bearer $ACCESS_TOKEN"

require 'restclient'
response = RestClient.execute method: :delete, url: "https://api.getbase.com/v2/deal_unqualified_reasons/1"

puts response

import requests
import json

response = requests.delete(
    url='https://api.getbase.com/v2/deal_unqualified_reasons/1',
    headers={
      'Authorization': 'Bearer $ACCESS_TOKEN'
    },
    verify=True
  )

print(response.text)

HTTP/1.1 204 No Content

Deal Unqualified Reasons

Properties

Endpoints

Retrieve all deal unqualified reasons

Parameters

Possible values:

Create a deal unqualified reason

Parameters

Retrieve a single deal unqualified reason

Parameters

Update a deal unqualified reason

Parameters

Delete a reason

Parameters