v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
Organizations

Update an organization by ID

put/organizations/{organizationId}

Path parameters

organizationIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of organization

Request body

namestring required
descriptionstring
websiteUrlstring

Example request

{
  "name": "An example name",
  "description": "An example name",
  "websiteUrl": "https://website-sample.com"
}

Response

successful operation - organization fields updated

Example response

{
  "organization": {
    "id": "95b11417-f18f-457f-8804-68e361f9164f",
    "name": "Acme Corp",
    "description": "An example name",
    "websiteUrl": "https://website-sample.com",
    "address": {
      "addressLine1": "An example name",
      "addressLine2": "An example name",
      "city": "An example name",
      "region": "An example name",
      "postalCode": "An example name",
      "country": "US"
    }
  }
}