# Create an address

POST https://YOUR_SPACE.signalwire.com/api/relay/rest/addresses
Content-Type: application/json

To create a new Address, make a POST request to the Address resource.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/relay-rest/addresses/create-address

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /addresses:
    post:
      operationId: create-address
      summary: Create an address
      description: >-
        To create a new Address, make a POST request to the Address resource.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Numbers_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_addresses
      parameters:
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '201':
          description: >-
            The request has succeeded and a new resource has been created as a
            result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '422':
          description: The request failed validation. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.ValidationError'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAddressRequest'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/relay/rest
components:
  schemas:
    AddressType:
      type: string
      enum:
        - Apartment
        - Basement
        - Building
        - Department
        - Floor
        - Office
        - Penthouse
        - Suite
        - Trailer
        - Unit
      description: Address type for sub-addresses.
      title: AddressType
    CreateAddressRequest:
      type: object
      properties:
        label:
          type: string
          description: >-
            A friendly name given to the address to help distinguish and search
            for different addresses within your project.
        country:
          type: string
          description: The ISO 3166 Alpha 2 country code.
        first_name:
          type: string
          description: First name of the occupant associated with this address.
        last_name:
          type: string
          description: Last name of the occupant associated with this address.
        street_number:
          type: string
          description: The number portion of the street address.
        street_name:
          type: string
          description: The name portion of the street address.
        address_type:
          $ref: '#/components/schemas/AddressType'
          description: >-
            If the address is divided into multiple sub-addresses, this
            identifies how the address is divided. Possible values are:
            Apartment, Basement, Building, Department, Floor, Office, Penthouse,
            Suite, Trailer, Unit.
        address_number:
          type: string
          description: >-
            If the address is divided into multiple sub-addresses, this
            identifies the particular sub-address.
        city:
          type: string
          description: The city portion of the street address.
        state:
          type: string
          description: >-
            The state/province/region of the street address. In the USA and
            Canada, use the two-letter abbreviated form.
        postal_code:
          type: string
          description: The postal code of the street address.
      required:
        - label
        - country
        - first_name
        - last_name
        - street_number
        - street_name
        - city
        - state
        - postal_code
      description: Request body for creating an address.
      title: CreateAddressRequest
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    AddressResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the Address on SignalWire.
        label:
          type: string
          description: >-
            A friendly name given to the address to help distinguish and search
            for different addresses within your project.
        country:
          type: string
          description: The ISO 3166 Alpha 2 country code.
        first_name:
          type: string
          description: First name of the occupant associated with this address.
        last_name:
          type: string
          description: Last name of the occupant associated with this address.
        street_number:
          type: string
          description: The number portion of the street address.
        street_name:
          type: string
          description: The name portion of the street address.
        address_type:
          oneOf:
            - $ref: '#/components/schemas/AddressType'
            - type: 'null'
          description: >-
            If the address is divided into multiple sub-addresses, this
            identifies how the address is divided.
        address_number:
          type:
            - string
            - 'null'
          description: >-
            If the address is divided into multiple sub-addresses, this
            identifies the particular sub-address.
        city:
          type: string
          description: The city portion of the street address.
        state:
          type: string
          description: >-
            The state/province/region of the street address. In the USA and
            Canada, use the two-letter abbreviated form.
        postal_code:
          type: string
          description: The postal code of the street address.
        zip_code:
          type: string
          description: >-
            The postal code of the street address. Alias for postal_code for
            backwards compatibility.
      required:
        - id
        - label
        - country
        - first_name
        - last_name
        - street_number
        - street_name
        - address_type
        - address_number
        - city
        - state
        - postal_code
        - zip_code
      description: Response containing a single address.
      title: AddressResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    Types.StatusCodes.SpaceApiErrorItem:
      type: object
      properties:
        detail:
          type: string
          description: A description of what caused the error.
        status:
          type: string
          description: The HTTP status code.
        title:
          type: string
          description: A short summary of the error type.
        code:
          type: string
          description: The error code.
      required:
        - detail
        - status
        - title
        - code
      description: Details about a specific validation error.
      title: Types.StatusCodes.SpaceApiErrorItem
    Types.StatusCodes.ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.SpaceApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request failed validation. See errors for details.
      title: Types.StatusCodes.ValidationError
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/relay/rest/addresses"

payload = {
    "label": "My Address",
    "country": "US",
    "first_name": "Emmett",
    "last_name": "Brown",
    "street_number": "1640",
    "street_name": "Riverside Drive",
    "city": "Alexandria",
    "state": "CA",
    "postal_code": "91905"
}
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/addresses';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <project_id>:<api_token>',
    'Content-Type': 'application/json'
  },
  body: '{"label":"My Address","country":"US","first_name":"Emmett","last_name":"Brown","street_number":"1640","street_name":"Riverside Drive","city":"Alexandria","state":"CA","postal_code":"91905"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/relay/rest/addresses"

	payload := strings.NewReader("{\n  \"label\": \"My Address\",\n  \"country\": \"US\",\n  \"first_name\": \"Emmett\",\n  \"last_name\": \"Brown\",\n  \"street_number\": \"1640\",\n  \"street_name\": \"Riverside Drive\",\n  \"city\": \"Alexandria\",\n  \"state\": \"CA\",\n  \"postal_code\": \"91905\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/relay/rest/addresses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"My Address\",\n  \"country\": \"US\",\n  \"first_name\": \"Emmett\",\n  \"last_name\": \"Brown\",\n  \"street_number\": \"1640\",\n  \"street_name\": \"Riverside Drive\",\n  \"city\": \"Alexandria\",\n  \"state\": \"CA\",\n  \"postal_code\": \"91905\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://your_space.signalwire.com/api/relay/rest/addresses")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"My Address\",\n  \"country\": \"US\",\n  \"first_name\": \"Emmett\",\n  \"last_name\": \"Brown\",\n  \"street_number\": \"1640\",\n  \"street_name\": \"Riverside Drive\",\n  \"city\": \"Alexandria\",\n  \"state\": \"CA\",\n  \"postal_code\": \"91905\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your_space.signalwire.com/api/relay/rest/addresses', [
  'body' => '{
  "label": "My Address",
  "country": "US",
  "first_name": "Emmett",
  "last_name": "Brown",
  "street_number": "1640",
  "street_name": "Riverside Drive",
  "city": "Alexandria",
  "state": "CA",
  "postal_code": "91905"
}',
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/addresses");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"label\": \"My Address\",\n  \"country\": \"US\",\n  \"first_name\": \"Emmett\",\n  \"last_name\": \"Brown\",\n  \"street_number\": \"1640\",\n  \"street_name\": \"Riverside Drive\",\n  \"city\": \"Alexandria\",\n  \"state\": \"CA\",\n  \"postal_code\": \"91905\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Basic <project_id>:<api_token>",
  "Content-Type": "application/json"
]
let parameters = [
  "label": "My Address",
  "country": "US",
  "first_name": "Emmett",
  "last_name": "Brown",
  "street_number": "1640",
  "street_name": "Riverside Drive",
  "city": "Alexandria",
  "state": "CA",
  "postal_code": "91905"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/relay/rest/addresses")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```