Update the current user's organization alias

Updates the organization alias of the currently authenticated user's organization. Only organization admins can perform this action.

PATCH/v3/me/organization
JWT

Request Body Schema

PropertyTypeDescriptionConstraints
organizationAlias*stringOrganization alias.min: 1, max: 256, pattern: ^[a-z0-9_-]+$

Request Example

{
  "organizationAlias": "a"
}
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",
    "organizationAlias": "string",
    "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 OK
{
  "id": "string",
  "organizationAlias": "string"
}