Twilio API (unofficial showcase)
POST/2010-04-01/Accounts/{AccountSid}/Addresses.json

Create an address

Creates an address resource for a specific account. Provide CustomerName, Street, City, Region, PostalCode, and IsoCountry; AutoCorrectAddress defaults to true when omitted. A 201 response returns the created address.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 10 body fields
AccountSidstringrequired
The SID of the account responsible for the new address. Must be 34 characters, starting with `AC` followed by 32 hexadecimal characters.

Address details to create. CustomerName, Street, City, Region, PostalCode, and IsoCountry are required.

CustomerNamestringrequired
The name to associate with the new address.
Streetstringrequired
The number and street address of the new address.
Citystringrequired
The city of the new address.
Regionstringrequired
The state or region of the new address.
PostalCodestringrequired
The postal code of the new address.
IsoCountrystringrequired
The ISO country code of the new address.
FriendlyNamestringoptional
A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.
EmergencyEnabledbooleanoptional
Whether to enable emergency calling on the new address. Can be: `true` or `false`.
AutoCorrectAddressbooleanoptional
Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
StreetSecondarystringoptional
The additional number and street address of the address.

1 status code
201Returns the created address object, including its SID, account SID, address details, emergency-calling status, and validation and verification status.
account_sidstringoptional
The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource.
citystringoptional
The city in which the address is located.
customer_namestringoptional
The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.
date_createdstringoptional
The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updatedstringoptional
The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
friendly_namestringoptional
The string that you assigned to describe the resource.
iso_countrystringoptional
The ISO country code of the address.
postal_codestringoptional
The postal code of the address.
regionstringoptional
The state or region of the address.
sidstringoptional
The unique string that that we created to identify the Address resource.
streetstringoptional
The number and street address of the address.
uristringoptional
The URI of the resource, relative to `https://api.twilio.com`.
emergency_enabledbooleanoptional
Whether emergency calling has been enabled on this number.
validatedbooleanoptional
Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been validated. `false` indicate the country doesn't require validation or the Address is not valid.
verifiedbooleanoptional
Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been verified. `false` indicate the country doesn't require verified or the Address is not valid.
street_secondarystringoptional
The additional number and street address of the address.

Error handling

CustomerName, Street, City, Region, PostalCode, and IsoCountry are required. IsoCountry must use the ISO country code format, and EmergencyEnabled and AutoCorrectAddress must be boolean values when provided. The AccountSid path parameter must be exactly 34 characters and match the account SID format AC followed by 32 hexadecimal characters.