# Order Updated

This is a webhook that will be called when an order is updated, it will contain the order and the status of the order.

Endpoint: POST OrderUpdated
Version: 1.0
Security: basicAuth, bearerAuth

## Request fields (application/json):

  - `event` (string)
    The event that triggered the webhook.
    Enum: "ORDER_UPDATED", "NUMBERS_ACTIVATED", "NUMBERS_CONFIRMED", "NUMBERS_REJECTED", "NEW_ORDER_NOTE"

  - `orderId` (string)
    The order ID that was updated.

  - `order` (object)

  - `order.desiredPortSchedule` (object, required)
    The date and time you want the numbers to be ported in. If you set a  and  in defaults those settings will be used if not set per order. If you haven't set defaults and do not set the time and time zone on the order the system default will be used.

 09:00:00 US/Eastern

  - `order.desiredPortSchedule.desiredPortDate` (string, required)
    The date you want the numbers to be ported in, in ISO format.
    Example: "2025-01-31"

  - `order.desiredPortSchedule.desiredPortTime` (string)
    The time you want the numbers to be ported in.
    Example: "09:00:00"

  - `order.desiredPortSchedule.desiredPortTimeZone` (string)
    The time zone you want to use for the desired port time.
    Enum: "US/Eastern", "US/Central", "US/Mountain", "US/Pacific"

  - `order.customerOrderReference` (string)
    Your reference you specified when creating the order
    Example: "123456"

  - `order.onDemandActivation` (boolean)
    If you use onDemand activation you will need to make sure the numbers are both confirmed and released for activation, if you don't use onDemand the numbers will be activated on the desiredPortDate is the recommended way.
If true the numbers will be activated as when you call , if false they will be activated on the desiredPortDate

  - `order.loaUploadedBy` (string)
    Name of the user uploading the LOA
    Example: "john doe"

  - `order.loaAttachmentDate` (string)
    Date when the LOA was uploaded. Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): .
    Example: "2024-09-24T12:00:00Z"

  - `order.phoneNumbers` (array)
    The numbers for the order in e164 format

  - `order.phoneNumbers.phoneNumber` (string, required)
    The phone number in [E.164](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537) format.
    Example: "+12345678901"

  - `order.phoneNumbers.endUser` (object, required)
    If specified, this will override the endUser for the order.

  - `order.phoneNumbers.endUser.name` (string, required)
    The name of the end user can be a person's name or company name. Please note if you are not using this yourself it should be the name/company of the actual user.
    Example: "Joe Doe"

  - `order.phoneNumbers.endUser.streetNum` (string, required)
    The end user's street number.
    Example: "123"

  - `order.phoneNumbers.endUser.streetName` (string, required)
    The end user's street name.
    Example: "Main"

  - `order.phoneNumbers.endUser.city` (string, required)
    The end user's city.
    Example: "Anytown"

  - `order.phoneNumbers.endUser.state` (string, required)
    The end user's state, using the two letter abbreviation.
    Example: "CA"

  - `order.phoneNumbers.endUser.zipCode` (string, required)
    The end user's zip code.
    Example: "12345"

  - `order.phoneNumbers.endUser.streetPreDir` (string)
    The prefix direction in the end user's address, if any.
    Example: "N"

  - `order.phoneNumbers.endUser.streetType` (string)
    The end user's street type, for example Road or Court.
    Example: "Court"

  - `order.phoneNumbers.endUser.streetPostDir` (string)
    The suffix direction in the end user's address, if any.
    Example: "SW"

  - `order.phoneNumbers.endUser.locationType1` (string)
    Any additional location information, such as suite or apartment.
    Example: "Suite"

  - `order.phoneNumbers.endUser.locationValue1` (string)
    Any additional location information, such as suite number or apartment number.
    Example: "2134"

  - `order.phoneNumbers.endUser.locationType2` (string)
    Field for additional location information, such as suite number or apartment number.

  - `order.phoneNumbers.endUser.locationValue2` (string)
    Field for additional location information, such as suite number or apartment number.

  - `order.phoneNumbers.endUser.locationType3` (string)
    Field for additional location information, such as suite number or apartment number.

  - `order.phoneNumbers.endUser.locationValue3` (string)
    Field for additional location information, such as suite number or apartment number.

  - `order.phoneNumbers.endUser.typeOfService` (string)
    The type of address. Available values are  for Business or  for Residence
    Enum: "B", "R"

  - `order.phoneNumbers.portOutInfo` (object, required)
    The port out information at the previous carrier for the number. Usually only a port-out PIN is required.

  - `order.phoneNumbers.portOutInfo.existingPortOutPin` (string)
    The existing port-out PIN from the previous carrier.

  - `order.phoneNumbers.portOutInfo.accountNum` (string)
    The account number associated with the number from the previous carrier.

  - `order.phoneNumbers.portOutInfo.accountPhoneNumber` (string)
    The contact phone number on the account.

  - `order.phoneNumbers.portOutInfo.authorizingName` (string)
    Name of the person authorizing the port-in.

  - `order.phoneNumbers.portOutInfo.authorizingDate` (string)
    Date of authorizing the port-in (must be today or earlier and cannot be in the future). Formatted as [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601): .
    Example: "2024-09-24T12:00:00Z"

  - `order.phoneNumbers.voiceConfiguration` (any)

  - `order.phoneNumbers.smsConfiguration` (object)
    If specified, this will override the sms configuration for the order.

  - `order.phoneNumbers.smsConfiguration.smsAppId` (string)

  - `order.phoneNumbers.features` (object)

  - `order.phoneNumbers.features.e911` (object)
    An object describing the emergency 911 contact address associated with the number.

  - `order.phoneNumbers.features.e911.name` (string)
    The contact name.

  - `order.phoneNumbers.features.e911.streetNum` (string)
    The street number for the emergency address.
    Example: "12345"

  - `order.phoneNumbers.features.e911.streetInfo` (string)
    The street name of the emergency location.
    Example: "Main St"

  - `order.phoneNumbers.features.e911.location` (string)
    The location for address.
    Example: "Apt 5"

  - `order.phoneNumbers.features.e911.city` (string)
    The city of the emergency location.
    Example: "Springfield"

  - `order.phoneNumbers.features.e911.state` (string)
    The state or province of the emergency location.
    Example: "IL"

  - `order.phoneNumbers.features.e911.postalCode` (string)
    The postal code of the emergency location.
    Example: "62701"

  - `order.phoneNumbers.features.e911.postalCodePlusFour` (string)
    The postal code of the emergency location.
    Example: "1234"

  - `order.phoneNumbers.newPortOutPin` (string)

  - `order.resellerName` (string)