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"
}'

{
  "created_by": null,
  "currency": "USD",
  "currency_symbol": "$",
  "date_created": "2013-02-01T00:54:51.097000+00:00",
  "date_updated": "2013-02-20T04:38:01.961000+00:00",
  "id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "lead_statuses": [
    {
      "id": "stat_8ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Not Serious"
    },
    {
      "id": "stat_3ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Qualified"
    },
    {
      "id": "stat_2ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Bad Fit"
    },
    {
      "id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "label": "Potential"
    }
  ],
  "memberships": [
    {
      "auto_record_calls": "unset",
      "id": "memb_wLKueFux8M2u2jshQPichvA5V44hpECtoljWbJS1PeY",
      "permissions_granted": [
        "bulk_edit",
        "export"
      ],
      "role_id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
      "track_email_opens": true,
      "user_email": "phil+sample@close.com",
      "user_first_name": "P",
      "user_full_name": "John Doe",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "user_last_name": "F",
      "user_phone": "16502822245"
    }
  ],
  "name": "New Name",
  "pipelines": [
    {
      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "date_created": "2019-11-04T11:04:13.014979",
      "date_updated": "2019-11-13T14:12:13.051542",
      "id": "pipe_6gV01if4wo7r2YTVQDWP2j",
      "name": "Sales",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "statuses": [
        {
          "id": "stat_3PB2sedHBCjwuBImAEwgHOo858f2j41lpROkcl51Fzp",
          "label": "Active",
          "type": "active"
        },
        {
          "id": "stat_IOCtLYbAclJ8XAcb3yLUhQA3zlmjtXz8JMBLyXnNMF8",
          "label": "Won",
          "type": "won"
        },
        {
          "id": "stat_3mmBOyMmaG8yc4DmAPp9WmgbjhVctVLlnd9gmvWxBe2",
          "label": "Lost",
          "type": "lost"
        }
      ],
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
    }
  ],
  "plan_type": "lite",
  "updated_by": null
}

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