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.
JSON format
Name | Read Only | Type | Description |
---|---|---|---|
id | true | number | Unique identifier of the deal unqualified reason. |
creator_id | true | number | Unique identifier of the user the deal unqualified reason was created by. |
name | false | string | Human-friendly unqualified reason explanation. |
created_at | true | string | Date and time of creation in UTC ISO8601 format. |
updated_at | true | string | Date and time of the last update in UTC ISO8601 format. |
Retrieve all deal unqualified reasons
GET /v2/deal_unqualified_reasons
Returns all deal unqualified reasons available to the user according to the parameters provided.
Parameters
Name | Required | Type | In | Description |
---|---|---|---|---|
page | false | number | Query | Page number to start from. Page numbering is 1-based and omitting page parameter will return the first page. |
per_page | false | number | Query | Number of records to return per page. Default limit is 25 and maximum number that can be returned is 100. |
sort_by | false | string | Query | 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 |
ids | false | string | Query | Comma separated list of deal unqualified reasons unique identifiers to be returned in a request. |
name | false | string | Query | Name of the unqualified reason to search for. This parameter is used in a strict sense. |
Allowed for
- Agents
Using cURL
curl -v -X GET https://api.getbase.com/v2/deal_unqualified_reasons \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"
Example response
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
POST /v2/deal_unqualified_reasons
Create a new deal unqualified reason. Unqualified reason's name must be unique.
Parameters
Name | Required | Type | In | Description |
---|---|---|---|---|
name | true | string | Body | Must be unique. |
Allowed for
- Agents
Using cURL
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"
}
}'
Example response
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
GET /v2/deal_unqualified_reasons/:id
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
Name | Required | Type | In | Description |
---|---|---|---|---|
id | true | number | Query | Unique identifier of the unqualified reason. |
Allowed for
- Agents
Using cURL
curl -v -X GET https://api.getbase.com/v2/deal_unqualified_reasons/4 \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"
Example response
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
PUT /v2/deal_unqualified_reasons/:id
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
Name | Required | Type | In | Description |
---|---|---|---|---|
id | true | number | Query | Unique identifier of the unqualified reason. |
name | false | string | Body | Must be unique. |
Allowed for
- Agents
Using cURL
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"
}
}'
Example response
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 /v2/deal_unqualified_reasons/:id
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
Name | Required | Type | In | Description |
---|---|---|---|---|
id | true | number | Query | Unique identifier of the unqualified reason. |
Allowed for
- Agents
Using cURL
curl -v -X DELETE https://api.getbase.com/v2/deal_unqualified_reasons/1 \
-H "Authorization: Bearer $ACCESS_TOKEN"
Example response
HTTP/1.1 204 No Content