/
phones.md
66 lines (36 loc) · 2.04 KB
/
phones.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
## Resources
# Phones
### Attributes
Field | Type | Note | Description
----------------|--------------|------------|------------------------------------
`id` | `integer` | read-only | The unique ID of the phone number.
`digits` | `string` | required | The phone number.
`phone_type` | `string` | | The type of phone number such as `fax` or `main`.
`is_primary` | `boolean` | | Whether or not this is the location's primary phone number. Defaults to `false`, unless this is the only phone number.
### Endpoints on Organizations
#### `GET /v1/organizations/:organization_id/phones`
Returns all phone numbers on an organization.
#### `POST /v1/organizations/:organization_id/phones`
Creates a phone number on an organization.
#### `PUT /v1/organizations/:organization_id/phones/:id`
Updates an organization's phone number.
#### `DELETE /v1/organizations/:organization_id/phones/:id`
Deletes an organization's phone number.
### Endpoints on Opportunities
#### `GET /v1/organizations/:organization_id/opportunities/:opportunity_id/phones`
Returns all phone numbers on an opportunity.
#### `POST /v1/organizations/:organization_id/opportunities/:opportunity_id/phones`
Creates a phone number on an opportunity.
#### `PUT /v1/organizations/:organization_id/opportunities/:opportunity_id/phones/:id`
Updates an opportunity's phone number.
#### `DELETE /v1/organizations/:organization_id/opportunities/:opportunity_id/phones/:id`
Deletes an opportunity's phone number.
### Endpoints on Locations
#### `GET /v1/organizations/:organization_id/locations/:id/phones`
Returns all phone numbers on a location.
#### `POST /v1/organizations/:organization_id/locations/:location_id/phones`
Creates a phone number on a location.
#### `PUT /v1/organizations/:organization_id/locations/:location_id/phones/:id`
Updates a location's phone number.
#### `DELETE /v1/organizations/:organization_id/locations/:location_id/phones/:id`
Deletes a location's phone number.