Skip to main content

Deletes all numbers associated with a phone number block

POST 

/phone_number_blocks/jobs/delete_phone_number_block

Creates a new background job to delete all the phone numbers associated with the given block. We will only consider the phone number block as deleted after all phone numbers associated with it are removed, so multiple executions of this job may be necessary in case some of the phone numbers present errors during the deletion process.

Request

Body

required

    phone_number_block_id stringrequired

Responses

202: Phone number blocks job delete phone numbers requested.

Schema

    data

    object

    id uuid

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    status string

    Possible values: [pending, in_progress, completed, failed]

    Default value: pending

    Indicates the completion status of the background operation.

    type string

    Possible values: [delete_phone_number_block]

    Identifies the type of the background job.

    etc date-time

    ISO 8601 formatted date indicating when the estimated time of completion of the background job.

    created_at string

    ISO 8601 formatted date indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date indicating when the resource was updated.

    successful_operations

    PhoneNumberBlocksJobSuccessfulOperation[]

  • Array [

  • phone_number e164

    The phone number in e164 format.

    id int64

    The phone number's ID

  • ]

  • failed_operations

    PhoneNumberBlocksJobFailedOperation[]

  • Array [

  • phone_number e164

    The phone number in e164 format.

    id int64

    The phone number's ID

    errors

    Error[]

  • Array [

  • code integerrequired
    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

    url string

    URL with additional information on the error.

  • ]

  • ]

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    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

    url string

    URL with additional information on the error.

  • ]

Loading...