Skip to main content

Create a comment for a porting order

POST 
/porting_orders/:id/comments

Creates a new comment for a porting order.

Request ​

Path Parameters

    id uuidrequired

    Porting Order id

Body

required

    body string

Responses ​

201: Successful response

Schema

    data

    object

    id uuid
    body string

    Body of comment

    porting_order_id uuid
    user_type string

    Possible values: [admin, user, system]

    Indicates whether this comment was created by a Telnyx Admin, user, or system

    user_id uuid

    The ID of the user who created this comment

    user_email email

    The email address of the user who created this comment

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Request samples

curl -L 'https://api.telnyx.com/v2/porting_orders/:id/comments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "body": "Please, let me know when the port completes"
}'

Response samples

{
  "data": {
    "id": "f1486bae-f067-460c-ad43-73a92848f902",
    "body": "Great experience so far",
    "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
    "user_type": "user",
    "user_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "user_email": "user@example.com",
    "record_type": "porting_comment",
    "created_at": "2021-03-19T10:07:15.527Z"
  }
}