Update a porting activation job

PATCH 
/porting_orders/:id/activation_jobs/:activationJobId

Updates the activation time of a porting activation job.

Path Parameters

id uuidrequired

Porting Order id

activationJobId uuidrequired

Activation Job Identifier

application/json

Body

required

activate_at date-time

The desired activation time. The activation time should be between any of the activation windows.

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

Uniquely identifies this activation job

status string

Possible values: [created, in-process, completed, failed]

Specifies the status of this activation job

activation_type string

Possible values: [scheduled, on-demand]

Specifies the type of this activation job

activate_at date-time

ISO 8601 formatted date indicating when the activation job should be executed. This time should be between some activation window.

activation_windows

object[]

List of allowed activation windows for this activation job

Array [

start_at date-time

ISO 8601 formatted date indicating when the activation window starts

end_at date-time

ISO 8601 formatted date indicating when the activation window ends

]

List of allowed activation windows for this activation job

record_type string

Identifies the type of the resource.

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 created.

{
  "data": {
    "id": "f1486bae-f067-460c-ad43-73a92848f902",
    "status": "created",
    "activation_type": "scheduled",
    "activate_at": "2021-03-19T10:07:15.527Z",
    "activation_windows": [
      {
        "start_at": "2021-03-19T10:07:15.527Z",
        "end_at": "2021-03-19T10:07:15.527Z"
      }
    ],
    "record_type": "porting_activation_job",
    "created_at": "2021-03-19T10:07:15.527Z",
    "updated_at": "2021-03-19T10:07:15.527Z"
  }
}

404: Not found

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

Request samples

• cURL

---

curl -L -X PATCH 'https://api.telnyx.com/v2/porting_orders/:id/activation_jobs/:activationJobId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "activate_at": "2019-01-01T00:00:00Z"
}'

Response samples

• 200

---

{
  "data": {
    "id": "f1486bae-f067-460c-ad43-73a92848f902",
    "status": "created",
    "activation_type": "scheduled",
    "activate_at": "2021-03-19T10:07:15.527Z",
    "activation_windows": [
      {
        "start_at": "2021-03-19T10:07:15.527Z",
        "end_at": "2021-03-19T10:07:15.527Z"
      }
    ],
    "record_type": "porting_activation_job",
    "created_at": "2021-03-19T10:07:15.527Z",
    "updated_at": "2021-03-19T10:07:15.527Z"
  }
}