> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt # update > Update an account. Update an account. Uses POST (Twilio convention). ### Schema ```yaml openapi: 3.1.0 info: title: API version: 1.0.0 paths: /Accounts/{Sid}: post: operationId: update_account summary: Update an Account description: >- Update a Project (also referred to as _Account_). #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Management_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). tags: - subpackage_accounts parameters: - name: Sid in: path description: The Project ID that uniquely identifies the Project to retrieve. required: true schema: $ref: '#/components/schemas/uuid' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AccountResponse' '400': description: >- The request was invalid or cannot be processed. Check the error details for more information. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '401': description: Authentication failed. Please verify your credentials and try again. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '404': description: >- The requested resource was not found. Please verify the resource identifier. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '422': description: >- The request could not be processed due to validation errors. Check the error details for more information. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAccountRequest' servers: - url: https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01 description: SignalWire Compatibility API components: schemas: uuid: type: string format: uuid description: Universal Unique Identifier. title: uuid UpdateAccountRequest: type: object properties: FriendlyName: type: string description: The new name for the Project. required: - FriendlyName description: Request body for updating an account. title: UpdateAccountRequest AccountStatus: type: string enum: - active description: The status of the Project. title: AccountStatus AccountType: type: string enum: - Full description: The type of the Project. title: AccountType SubresourceUris: type: object properties: addresses: description: URI for addresses. Not supported. available_phone_numbers: type: string description: URI for available phone numbers. applications: type: string description: URI for applications. authorized_connect_apps: description: URI for authorized connect apps. Not supported. calls: type: string description: URI for calls. conferences: type: string description: URI for conferences. connect_apps: description: URI for connect apps. Not supported. incoming_phone_numbers: type: string description: URI for incoming phone numbers. keys: description: URI for keys. Not supported. notifications: description: URI for notifications. Not supported. outgoing_caller_ids: description: URI for outgoing caller IDs. Not supported. queues: type: string description: URI for queues. recordings: type: string description: URI for recordings. sandbox: description: URI for sandbox. Not supported. sip: description: URI for SIP. Not supported. short_codes: description: URI for short codes. Not supported. messages: type: string description: URI for messages. transcriptions: type: string description: URI for transcriptions. usage: description: URI for usage. Not supported. required: - addresses - available_phone_numbers - applications - authorized_connect_apps - calls - conferences - connect_apps - incoming_phone_numbers - keys - notifications - outgoing_caller_ids - queues - recordings - sandbox - sip - short_codes - messages - transcriptions - usage description: A Map of sub-resources that are linked to the given Project. title: SubresourceUris AccountResponse: type: object properties: sid: $ref: '#/components/schemas/uuid' description: The unique identifier for this Project. friendly_name: type: string description: The name of the Project. status: $ref: '#/components/schemas/AccountStatus' description: The status of the Project. Always 'active'. auth_token: type: string description: >- The authorization token for this Project. Always returns 'redacted' for security. date_created: type: string description: The date and time this Project was created, in RFC 2822 format. date_updated: type: string description: The date and time this Project was last updated, in RFC 2822 format. type: $ref: '#/components/schemas/AccountType' description: The type of the Project. Always 'Full'. owner_account_sid: $ref: '#/components/schemas/uuid' description: >- The Project ID of the parent project. For parent projects, this is the same as sid. region_preference: type: string description: The preferred region for the Project. uri: type: string description: The URI for the Project. subproject: type: boolean description: Whether this project is a sub-project of another project. signing_key: type: - string - 'null' description: >- The signing key for the Project. Only returned once when a subproject is created. Subsequent requests return null. subresource_uris: $ref: '#/components/schemas/SubresourceUris' description: A map of URIs for sub-resources linked to this Project. required: - sid - friendly_name - status - auth_token - date_created - date_updated - type - owner_account_sid - region_preference - uri - subproject - signing_key - subresource_uris description: Response containing a single account. title: AccountResponse CompatibilityErrorResponse: type: object properties: code: type: integer description: Error code. message: type: string description: Error message. more_info: type: string description: URL for more information about the error. status: type: integer description: HTTP status code. required: - code - message - more_info - status description: Error response model. title: CompatibilityErrorResponse ``` ## **Response Example** ### Response (200) ```json { "sid": "b3877c40-da60-4998-90ad-b792e98472af", "friendly_name": "My Project", "status": "active", "auth_token": "redacted", "date_created": "Sat, 15 Sep 2018 10:00:00 +0000", "date_updated": "Sat, 16 Sep 2018 10:00:00 +0000", "type": "Full", "owner_account_sid": "b3877c40-da60-4998-90ad-b792e98472af", "region_preference": "us-east", "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af", "subproject": false, "signing_key": null, "subresource_uris": { "addresses": null, "available_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers", "applications": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications", "authorized_connect_apps": null, "calls": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls", "conferences": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences", "connect_apps": null, "incoming_phone_numbers": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers", "keys": null, "notifications": null, "outgoing_caller_ids": null, "queues": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues", "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Recordings", "sandbox": null, "sip": null, "short_codes": null, "messages": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Messages", "transcriptions": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Transcriptions", "usage": null } } ``` ## **Example** ```typescript {9} import { RestClient } from "@signalwire/sdk"; const client = new RestClient({ project: "your-project-id", token: "your-api-token", host: "your-space.signalwire.com", }); await client.compat.accounts.update("account-sid", { FriendlyName: "Sales Team" }); ```