> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# update

> Update a conference (e.g., end it or set an announce URL).

Update a conference (e.g., end it, or set the announce URL). Uses POST (Twilio convention).

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /Accounts/{AccountSid}/Conferences/{Sid}:
    post:
      operationId: update_conference
      summary: Update Conference
      description: >-
        Allows you to modify the properties of a conference.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Voice_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_conferences
      parameters:
        - name: AccountSid
          in: path
          description: The unique identifier for the account that created this conference.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
        - name: Sid
          in: path
          description: The unique identifier for this conference.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceResponse'
        '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'
        '503':
          description: The service is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConferenceRequest'
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
    UpdateConferenceRequestStatus:
      type: string
      enum:
        - completed
      description: >-
        The status of this conference. Only 'completed' is allowed to end the
        conference.
      title: UpdateConferenceRequestStatus
    UpdateConferenceRequestAnnounceMethod:
      type: string
      enum:
        - GET
        - POST
      default: POST
      description: >-
        Whether the request to `AnnounceUrl` is a `GET` or a `POST`. Default is
        `POST`.
      title: UpdateConferenceRequestAnnounceMethod
    UpdateConferenceRequest:
      type: object
      properties:
        Status:
          $ref: '#/components/schemas/UpdateConferenceRequestStatus'
          description: >-
            The status of this conference. Only 'completed' is allowed to end
            the conference.
        AnnounceUrl:
          type: string
          format: uri
          description: The URL to send conference announcements to.
        AnnounceMethod:
          $ref: '#/components/schemas/UpdateConferenceRequestAnnounceMethod'
          default: POST
          description: >-
            Whether the request to `AnnounceUrl` is a `GET` or a `POST`. Default
            is `POST`.
      description: Request body for updating a conference.
      title: UpdateConferenceRequest
    ConferenceStatus:
      type: string
      enum:
        - init
        - in-progress
        - completed
      description: Conference status.
      title: ConferenceStatus
    ConferenceSubresourceUris:
      type: object
      properties:
        participants:
          type: string
          description: Links to the participants.
        recordings:
          type: string
          description: Links to the recordings.
      required:
        - participants
        - recordings
      description: Conference subresource URIs.
      title: ConferenceSubresourceUris
    ConferenceResponse:
      type: object
      properties:
        sid:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier for this conference.
        account_sid:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier for the account that created this conference.
        date_created:
          type: string
          description: The date, in RFC 2822 format, this conference was created.
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this conference was updated.
        friendly_name:
          type: string
          description: A description, up to 64 characters, of the conference room.
        status:
          $ref: '#/components/schemas/ConferenceStatus'
          description: The status of this conference.
        api_version:
          type: string
          description: The version of the SignalWire API.
        region:
          type: string
          description: The region where this conference audio was mixed.
        uri:
          type: string
          description: The URI for this conference.
        subresource_uris:
          $ref: '#/components/schemas/ConferenceSubresourceUris'
          description: The links to associated subresources.
      required:
        - sid
        - account_sid
        - date_created
        - date_updated
        - friendly_name
        - status
        - api_version
        - region
        - uri
        - subresource_uris
      description: Response containing a single conference.
      title: ConferenceResponse
    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-b792e98472cf",
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "date_created": "Mon, 24 Sept 2018 21:00:00 +0000",
  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
  "friendly_name": "My Conference Room",
  "status": "init",
  "api_version": "2010-04-01",
  "region": "us1",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json",
  "subresource_uris": {
    "participants": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants.json",
    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json"
  }
}
```

## **Example**

```python {9}
from signalwire.rest import RestClient

client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)

client.compat.conferences.update("CF...", Status="completed")
```