v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Porting Orders

Initiate an action requirement

Initiates a specific action requirement for a porting order.

post/porting_orders/{porting_order_id}/action_requirements/{id}/initiate

Path parameters

porting_order_idstring required

The ID of the porting order

idstring required

The ID of the action requirement

Request body

Example request

{
  "params": {
    "first_name": "John",
    "last_name": "Doe"
  }
}

Response

Successful response

Example response

{
  "data": {
    "action_type": "document_upload",
    "action_url": "https://example.com/action",
    "created_at": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "porting_order_id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "record_type": "porting_action_requirement",
    "requirement_type_id": "53970723-fbff-4f46-a975-f62be6c1a585",
    "status": "created",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}