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

    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

    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

Responses

200: Successful response

Schema

    data

    object

    id uuid

    Uniquely identifies the LOA configuration.

    company_name string

    The name of the company

    organization_id string

    The organization that owns the LOA configuration

    name string

    The name of the LOA configuration

    logo

    object

    The logo to be used in the LOA.

    document_id uuid

    Identifies the document that contains the logo.

    content_type string

    Possible values: [image/png]

    The content type of the logo.

    address

    object

    The address of the company.

    street_address string

    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 string

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

    The country code of the company

    contact

    object

    The contact information of the company.

    email email

    The email address of the contact

    phone_number string

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

    The phone number of the contact

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

404: Resource not found

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

500: Internal server error

Loading...