STstuut
business-units

Update a Business Unit

Rename a business unit or edit its description / customer-facing display name (PATCH: only fields present are applied). Requires organization admin.

patch/v2/business-units/{business_unit_id}

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

business_unit_idstring required

Request body

namestring nullable

The name of the business unit.

descriptionstring nullable

Optional description of the business unit.

display_namestring nullable

Customer-facing BU name for outbound content; NULL uses the organization name.

Response

Successful Response

created_atstring date-time required
modified_atstring date-time nullable required
idstring required
namestring required

The name of the business unit.

descriptionstring nullable required

Optional description of the business unit.

display_namestring nullable required

Customer-facing BU name for outbound content; NULL uses the organization name.

default_phone_number_idstring nullable required

The BU's fallback number, used when none of its numbers match the destination country.

business_identity_idstring nullable required

The BU's own legal entity / Twilio Secondary Profile; NULL if it shares the org's identity.

verification_status'draft' | 'pending_review' | 'in_review' | 'twilio_approved' | 'twilio_rejected' required

Verification state of a business identity's Twilio Secondary Profile.

Member names mirror Twilio's vocabulary, so the only difference from its wire strings is the separator — Twilio hyphenates (twilio-approved) where a Python name can't. from_twilio converts on that one character, which keeps the hyphenated spelling out of the enum, the column (which stores the NAME) and our API without a lookup table to keep in sync.

member_idsstring[] required
objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.