Update an organization

PUT

https://api.close.com/api/v1/organization/:id/

PUT

/api/v1/organization/:id/

$ curl -X PUT https://api.close.com/api/v1/organization/id/ \
>      -H "Content-Type: application/json" \
>      -u "<CLOSE_API_KEY>:" \
>      -d '{
>   "currency": "USD",
>   "lead_statuses": [
>     {
>       "id": "stat_8ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk"
>     },
>     {
>       "id": "stat_3ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk"
>     },
>     {
>       "id": "stat_2ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk"
>     },
>     {
>       "id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk"
>     }
>   ],
>   "name": "New Name"
> }'

1 {
2   "created_by": null,
3   "currency": "USD",
4   "currency_symbol": "$",
5   "date_created": "2013-02-01T00:54:51.097000+00:00",
6   "date_updated": "2013-02-20T04:38:01.961000+00:00",
7   "id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
8   "lead_statuses": [
9     {
10       "id": "stat_8ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
11       "label": "Not Serious"
12     },
13     {
14       "id": "stat_3ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
15       "label": "Qualified"
16     },
17     {
18       "id": "stat_2ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
19       "label": "Bad Fit"
20     },
21     {
22       "id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
23       "label": "Potential"
24     }
25   ],
26   "memberships": [
27     {
28       "auto_record_calls": "unset",
29       "id": "memb_wLKueFux8M2u2jshQPichvA5V44hpECtoljWbJS1PeY",
30       "permissions_granted": [
31         "bulk_edit",
32         "export"
33       ],
34       "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
35       "track_email_opens": true,
36       "user_email": "phil+sample@close.com",
37       "user_first_name": "P",
38       "user_full_name": "John Doe",
39       "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
40       "user_last_name": "F",
41       "user_phone": "16502822245"
42     }
43   ],
44   "name": "New Name",
45   "pipelines": [
46     {
47       "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
48       "date_created": "2019-11-04T11:04:13.014979",
49       "date_updated": "2019-11-13T14:12:13.051542",
50       "id": "pipe_6gV01if4wo7r2YTVQDWP2j",
51       "name": "Sales",
52       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
53       "statuses": [
54         {
55           "id": "stat_3PB2sedHBCjwuBImAEwgHOo858f2j41lpROkcl51Fzp",
56           "label": "Active",
57           "type": "active"
58         },
59         {
60           "id": "stat_IOCtLYbAclJ8XAcb3yLUhQA3zlmjtXz8JMBLyXnNMF8",
61           "label": "Won",
62           "type": "won"
63         },
64         {
65           "id": "stat_3mmBOyMmaG8yc4DmAPp9WmgbjhVctVLlnd9gmvWxBe2",
66           "label": "Lost",
67           "type": "lost"
68         }
69       ],
70       "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
71     }
72   ],
73   "plan_type": "lite",
74   "updated_by": null
75 }

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_expandstringOptional

Request

This endpoint expects an object.

currencystringOptional

Default currency as a three-letter ISO 4217 currency code.

enable_unsubscribe_linkbooleanOptional

Enable the unsubscribe link by default in new email templates.

lead_statuseslist of objectsOptional

The organization's lead statuses. Provide the full list in the desired order to reorder them.

namestringOptional>=1 character

The organization's name.

require_unsubscribe_linkbooleanOptional

Require an unsubscribe link in Bulk Emails and Workflows.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error