Updates information for a SIM Card Data Usage Notification

PATCH 
/sim_card_data_usage_notifications/:id

Updates information for a SIM Card Data Usage Notification.

Request

Path Parameters

id uuidrequired

Identifies the resource.

application/json

Body

required

sim_card_id uuid

The identification UUID of the related SIM card resource.

threshold

object

Data usage threshold that will trigger the notification.

amount decimal

unit string

Possible values: [MB, GB]

Data usage threshold that will trigger the notification.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

The SIM card individual data usage notification information.

id uuid

Identifies the resource.

sim_card_id uuid

The identification UUID of the related SIM card resource.

record_type string

threshold

object

Data usage threshold that will trigger the notification.

amount decimal

unit string

Possible values: [MB, GB]

Data usage threshold that will trigger the notification.

created_at string

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

updated_at string

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

The SIM card individual data usage notification information.

{
  "data": {
    "id": "79228acc-3f08-4e70-ac68-cb5aae8b537a",
    "sim_card_id": "b34c1683-cd85-4493-b9a5-315eb4bc5e19",
    "threshold": {
      "amount": "2048.0",
      "unit": "MB"
    },
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

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

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L -X PATCH 'https://api.telnyx.com/v2/sim_card_data_usage_notifications/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "id": "79228acc-3f08-4e70-ac68-cb5aae8b537a",
  "sim_card_id": "b34c1683-cd85-4493-b9a5-315eb4bc5e19",
  "threshold": {
    "amount": "2048.0",
    "unit": "MB"
  },
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z"
}'

Response samples

• 200
• default

---

{
  "data": {
    "id": "79228acc-3f08-4e70-ac68-cb5aae8b537a",
    "sim_card_id": "b34c1683-cd85-4493-b9a5-315eb4bc5e19",
    "threshold": {
      "amount": "2048.0",
      "unit": "MB"
    },
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}