Skip to main content

Update a billing group

PATCH 
/billing_groups/:id

Update a billing group

Request​

Path Parameters

    id uuidrequired

    The id of the billing group

Body

required

Update billing group object

    name string

    A name for the billing group

Responses​

200: Expected billing group response to a valid request

Schema

    data

    object

    record_type string

    Possible values: [billing_group]

    Identifies the type of the resource.

    id uuid

    Identifies the type of resource.

    organization_id uuid

    Identifies the organization that owns the resource.

    name string

    A user-specified name for the billing group

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

    deleted_at date-time

    ISO 8601 formatted date indicating when the resource was removed.

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L -X PATCH 'https://api.telnyx.com/v2/billing_groups/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string"
}'

Response samples

{
  "data": {
    "record_type": "billing_group",
    "id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
    "organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
    "name": "My billing group name",
    "created_at": "2019-10-15T10:07:15.527Z",
    "updated_at": "2019-10-15T10:07:15.527Z",
    "deleted_at": null
  }
}