PATCH
/
orgs
/
{orgId}
Update an organization
curl --request PATCH \
  --url https://api.withampersand.com/v1/orgs/{orgId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "updateMask": [
    "label"
  ],
  "org": {
    "label": "org-123"
  }
}'
{
  "id": "9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79",
  "label": "Acme Inc",
  "defaultTeamId": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
orgId
string
required

ID of the organization.

Body

application/json
​
updateMask
string[]
required

Array of field paths specifying which fields to update. Allowed values include:

  • label
Example:
["label"]
​
org
object
required

Response

Updated org

​
id
string
required

The organization ID.

Example:

"9f7c3e2a-61b8-4f5c-8d1a-eb24f3b05d79"

​
label
string
required

The organization label.

Example:

"Acme Inc"

​
defaultTeamId
string
required

The ID of the Everyone team for the org.

​
createTime
string<date-time>
required

The time the organization was created.

​
updateTime
string<date-time>

The time the organization was updated.