Create address

POST /2010-04-01/Accounts/{AccountSid}/Addresses.json

An Address instance resource represents your or your customer's physical location within a country. Around the world, some local authorities require the name and address of the user to be on file with Twilio to purchase and own a phone number.

Path parameters

AccountSid string Required

The SID of the Account that will be responsible for the new Address resource.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

CustomerName string Required

The name to associate with the new address.
Street string Required

The number and street address of the new address.
City string Required

The city of the new address.
Region string Required

The state or region of the new address.
PostalCode string Required

The postal code of the new address.
IsoCountry string(iso-country-code) Required

The ISO country code of the new address.
FriendlyName string

A descriptive string that you create to describe the new address. It can be up to 64 characters long.
EmergencyEnabled boolean

Whether to enable emergency calling on the new address. Can be: true or false.
AutoCorrectAddress boolean

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.
StreetSecondary string

The additional number and street address of the address.

Responses

201 application/json

Created
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that is responsible for the Address resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- city string | null
  
  The city in which the address is located.
- customer_name string | null
  
  The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.
- date_created string(date-time-rfc-2822) | null
  
  The date and time in GMT that the resource was created specified in RFC 2822 format.
- date_updated string(date-time-rfc-2822) | null
  
  The date and time in GMT that the resource was last updated specified in RFC 2822 format.
- friendly_name string | null
  
  The string that you assigned to describe the resource.
- iso_country string(iso-country-code) | null
  
  The ISO country code of the address.
- postal_code string | null
  
  The postal code of the address.
- region string | null
  
  The state or region of the address.
- sid string | null
  
  The unique string that that we created to identify the Address resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AD[0-9a-fA-F]{32}$.
- street string | null
  
  The number and street address of the address.
- uri string | null
  
  The URI of the resource, relative to https://api.twilio.com.
- emergency_enabled boolean | null
  
  Whether emergency calling has been enabled on this number.
- validated boolean | null
  
  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.
- verified boolean | null
  
  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_secondary string | null
  
  The additional number and street address of the address.

POST /2010-04-01/Accounts/{AccountSid}/Addresses.json

curl \
 --request POST 'https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Addresses.json' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'City=city&Region=region&Street=street&IsoCountry=US&PostalCode=postal_code&CustomerName=customer_name&FriendlyName=friendly_name'

Request example

{"City"=>"city", "Region"=>"region", "Street"=>"street", "IsoCountry"=>"US", "PostalCode"=>"postal_code", "CustomerName"=>"customer_name", "FriendlyName"=>"friendly_name"}

Response examples (201)

{
  "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
  "city": "SF",
  "region": "CA",
  "street": "4th",
  "verified": false,
  "validated": false,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "iso_country": "US",
  "postal_code": "94019",
  "date_created": "Tue, 18 Aug 2015 17:07:30 +0000",
  "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000",
  "customer_name": "name",
  "friendly_name": "Main Office",
  "street_secondary": "Suite 300",
  "emergency_enabled": false
}