PATCH

/user/v1/organizations/{organizationId}

Update an organization

Updates specified organization.

path parameters

  • organizationId

    string

    Required

    The identifier of the organization.

body parameters

  • uniqueId

    string

    The client defined unique identifier of the organization account.

    It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.

    ID's starting with org_ are reserved.

  • displayName

    string

    The human-readable display name of the organization.

    The maximum length is 200 characters.

  • email

    string

    The email address of the organization.

    The maximum length is 320 characters.

  • flowId

    string

    The flow identifier associated with the creation of the organization.

    The flow type must be SIGNUP and associated with the user creating the organization.

Returns

  • id

    string

    The system-assigned identifier of the organization.

  • uniqueId

    string

    The client defined unique identifier of the organization account.

  • displayName

    string

    The human-readable display name of the organization.

  • email

    string

    The email address of the organization.

  • emailVerified

    boolean

    Whether the organization's email address has been verified.

  • imageUrl

    string

    The photo/avatar URL of the organization.

  • memberCount

    int32

    The number of members in the organization.

    This includes disabled users, but does not include user's marked for deletion.

  • disabled

    boolean

    Whether the organization is disabled.

curl https://api.userhub.com/user/v1/organizations/org_28seyVGVL1got6 \
  -H "UserHub-Api-Key: $USER_API_KEY" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" \
  -X PATCH \
  --json '{
    "displayName": "Stark Industries"
  }'
Response bodyJSON
{
  "id": "org_28seyVGVL1got6",
  "displayName": "Stark Industries",
  "email": "[email protected]",
  "emailVerified": true,
  "imageUrl": "https://example.com/acme.jpg",
  "memberCount": 1
}
PreviousGet an organization
NextDelete an organization

Turn users intorevenue
$

Subscribe to monthly product updates

© 2024 UserHub

Integrations

    UserHub & Auth0UserHub & Stripe BillingUserHub & Google CloudUserHub & FirebaseUserHub & Custom Auth