Skip to main content

Update a credential

PATCH 
/telephony_credentials/:id

Update an existing credential.

Request​

Path Parameters

    id stringrequired

    Identifies the resource.

Body

required

Parameters that can be updated in a credential

    name string
    tag string

    Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials.

    connection_id string

    Identifies the Credential Connection this credential is associated with.

    expires_at string

    ISO-8601 formatted date indicating when the credential will expire.

Responses​

200: Successful response with details about a credential

Schema

    data

    object

    id string

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    name string
    resource_id string

    Identifies the resource this credential is associated with.

    expired boolean

    Defaults to false

    sip_username string

    The randomly generated SIP username for the credential.

    sip_password string

    The randomly generated SIP password for the credential.

    created_at string

    ISO-8601 formatted date indicating when the resource was created.

    updated_at string

    ISO-8601 formatted date indicating when the resource was updated.

    expires_at string

    ISO-8601 formatted date indicating when the resource will expire.

401: Unauthorized

404: Resource not found

422: Bad request

Loading...