Associated Contacts

The Associated Contact is an object used to present a relationship between a deal and a contact. In addition, each Associated Contact is assigned a role that corresponds to the role it plays in the deal.

With every deal, there might be any number of Associated Contacts.

Properties

Attribute	Description
contact_id number	Unique identifier of the contact to be associated with the deal.
role string	Role name. Possible values: involved
created_at string readonly	Date and time that the associated contact was created in UTC (ISO8601 format).
updated_at string readonly	Date and time of the last update on the associated contact in UTC (ISO8601 format).

Retrieve deal's associated contacts

Returns all deal associated contacts.

Parameters

Attribute	Description
page number optional	Page number to start from. Page numbering starts at 1, and omitting the `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 the maximum number that can be returned is 100. e.g. `?per_page=20`

Action

GET /v2/deals/:deal_id/associated_contacts

Examples

Retrieve all deals

GET /v2/deals/:deal_id/associated_contacts HTTP/1.1

Accept: application/json
Authorization: Bearer $ACCESS_TOKEN

curl -v -X GET https://api.getbase.com/v2/deals/:deal_id/associated_contacts \
-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/deals/:deal_id/associated_contacts", headers: headers

puts response

import requests
import json

response = requests.get(
    url='https://api.getbase.com/v2/deals/:deal_id/associated_contacts',
    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": {
        "contact_id": 2,
        "role": "involved",
        "created_at": "2014-08-27T16:32:56Z",
        "updated_at": "2014-08-27T17:32:56Z"
      },
      "meta": {
        "type": "associated_contact"
      }
    }
  ],
  "meta": {
    "type": "collection",
    "count": 1,
    "links": {
      "self": "http://api.getbase.com/v2/deals/1/associated_contacts"
    }
  }
}

Create an associated contact

Creates a deal’s associated contact and its role. If the specified deal or contact does not exist, the request will return an error.

Parameters

Attribute	Description
contact_id number required	Unique identifier of the contact to be associated with the deal. e.g. `"contact_id": "2"`
role string optional	Role name. Default value: `involved`. e.g. `"role": "involved"`

Action

POST /v2/deals/:deal_id/associated_contacts

Examples

Associate a contact with id 2 with a deal with id 1

POST /v2/deals/1/associated_contacts HTTP/1.1

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

{
  "data": {
    "contact_id": 2,
    "role": "involved"
  },
  "meta": {
    "type": "associated_contact"
  }
}

curl -v -X POST https://api.getbase.com/v2/deals/1/associated_contacts \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-d '{
  "data": {
    "contact_id": 2,
    "role": "involved"
  },
  "meta": {
    "type": "associated_contact"
  }
}'

require 'restclient'
headers = {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "Authorization" => "Bearer $ACCESS_TOKEN"
}
body = '{
"data": {
  "contact_id": 2,
  "role": "involved"
},
"meta": {
  "type": "associated_contact"
}
}
'
response = RestClient.execute method: :post, url: "https://api.getbase.com/v2/deals/1/associated_contacts", payload: body, headers: headers

puts response

import requests
import json

payload = {
  'data': {
    'contact_id': 2,
    'role': 'involved'
  },
  'meta': {
    'type': 'associated_contact'
  }
}

response = requests.post(
    url='https://api.getbase.com/v2/deals/1/associated_contacts',
    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": {
    "contact_id": 2,
    "role": "involved",
    "created_at": "2014-08-27T16:32:56Z",
    "updated_at": "2014-08-27T17:32:56Z"
  },
  "meta": {
    "type": "associated_contact"
  }
}

Remove an associated contact

Remove a deal’s associated contact. If a deal with the supplied unique identifier does not exist, it returns an error. This operation cannot be undone.

Parameters

Attribute	Description
deal_id number required	Unique identifier of the deal. e.g. `?deal_id=1`
contact_id number required	Unique identifier of the contact. e.g. `?contact_id=2`

Action

DELETE /v2/deals/:deal_id/associated_contacts/:contact_id

Examples

Remove an associated contact with id 2 from a deal with id 1

DELETE /v2/deals/1/associated_contacts/2 HTTP/1.1

Authorization: Bearer $ACCESS_TOKEN

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

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

puts response

import requests
import json

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

print(response.text)

HTTP/1.1 204 No Content

Associated Contacts

Properties

Possible values:

Endpoints

Retrieve deal's associated contacts

Parameters

Create an associated contact

Parameters

Remove an associated contact

Parameters