Update an organization

Updates the specified organization by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/organizations/{id}

JWT

organization:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the organization.

Request Body Schema

Property	Type	Description	Constraints
name	string	Name of the organization.	min: 1, max: 256
email	string	Notification email of the organization.	min: 1, max: 256, format: email
description	string	Description for the organization.	min: 0, max: 256
allowedUsers	integer	Max number of users the organization is allowed to create. Set to -1 to allow unlimited users.	min: -1, max: 2147483647, format: int32
address	object
addressLine1	string	Address line1.	min: 0, max: 256
addressLine2	string	Address line2.	min: 0, max: 256
city	string	Address city.	min: 0, max: 256
state	string	Address state.	min: 0, max: 256
country	string	Address country.	min: 0, max: 256
postalCode	string	Address postal code.	min: 0, max: 256
resellerId	string	Unique identifier for the reseller.	min: 0, max: 256

Request Example

{
  "name": "string",
  "email": "user@example.com",
  "description": "string",
  "allowedUsers": -1,
  "address": {
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string"
  },
  "resellerId": "string"
}

Triggers webhook: organization.updated

POST <your-webhook-url>
{
  "event": "organization.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "email": "string",
    "description": "string",
    "allowedUsers": 0,
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postalCode": "string"
    },
    "resellerId": "string",
    "reseller": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "email": "string",
      "description": "string",
      "allowedUsers": 0,
      "allowedOrganizations": 0
    }
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "email": "string",
  "description": "string",
  "allowedUsers": 0,
  "address": {
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string"
  },
  "resellerId": "string",
  "reseller": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "email": "string",
    "description": "string",
    "allowedUsers": 0,
    "allowedOrganizations": 0
  }
}