Skip to main content

Update a LOA configuration

PATCH 
/porting/loa_configurations/:id

Update a specific LOA configuration.

Request

Path Parameters

    id uuidrequired

    Identifies a LOA configuration.

Body

required

    name stringrequired

    The name of the LOA configuration

    logo

    object

    required

    The logo of the LOA configuration

    document_id uuidrequired

    The document identification

    The logo of the LOA configuration

    company_name stringrequired

    The name of the company

    address

    object

    required

    The address of the company.

    street_address stringrequired

    The street address of the company

    extended_address string

    The extended address of the company

    city string

    The locality of the company

    state string

    Possible values: Value must match regular expression ^[A-Z]{2}$

    The administrative area of the company

    zip_code string

    Possible values: Value must match regular expression ^[0-9]{5}(?:-[0-9]{4})?$

    The postal code of the company

    country_code stringrequired

    Possible values: Value must match regular expression ^[A-Z]{2}$

    The country code of the company

    The address of the company.

    contact

    object

    required

    The contact information of the company.

    email emailrequired

    The email address of the contact

    phone_number stringrequired

    Possible values: Value must match regular expression ^\+\d{11,15}$

    The phone number of the contact

    The contact information of the company.

Responses

200: Successful response

404: Resource not found

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

500: Internal server error

Request samples


curl -L -X PATCH 'https://api.telnyx.com/v2/porting/loa_configurations/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "My LOA Configuration",
"logo": {
"document_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"company_name": "Telnyx",
"address": {
"street_address": "311 W. Superior St",
"extended_address": "Suite 504",
"city": "Chicago",
"state": "IL",
"zip_code": "60654",
"country_code": "US"
},
"contact": {
"email": "testing@telnyx.com",
"phone_number": "+12003270001"
}
}'

Response samples


{
"data": {
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"company_name": "Telnyx",
"organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
"name": "My LOA Configuration",
"logo": {
"document_id": "f1486bae-f067-460c-ad43-73a92848f902",
"content_type": "image/png"
},
"address": {
"street_address": "311 W. Superior St",
"extended_address": "Suite 504",
"city": "Chicago",
"state": "IL",
"zip_code": "60654",
"country_code": "US"
},
"contact": {
"email": "testing@telnyx.com",
"phone_number": "+12003270001"
},
"record_type": "porting_loa_configuration",
"created_at": "2021-03-19T10:07:15.527000Z",
"updated_at": "2021-03-19T10:07:15.527000Z"
}
}