Address

A profile's address: create or update, list, or get one.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

addresss, err := client.Address(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(addresss)
address, err := client.Address(nil).Load(map[string]any{"id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(address)
created, err := client.Address(nil).Create(map[string]any{"details": map[string]any{}, "profile": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local addresss, err = client:Address():list()
local address, err = client:Address():load({ id = 1 })
local created, err = client:Address():create({ details = {}, profile = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$addresss = $client->Address()->list();
$address = $client->Address()->load(["id" => 1]);
$created = $client->Address()->create(["details" => [], "profile" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

addresss = client.Address().list()
address = client.Address().load({"id": 1})
created = client.Address().create({ "details": {}, "profile": 1 })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

addresss = client.Address.list()
address = client.Address.load({ "id" => 1 })
created = client.Address.create({ "details" => {}, "profile" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const addresss = await client.Address().list()
const address = await client.Address().load({ id: 1 })
const created = await client.Address().create({ details: {}, profile: 1 })

Fields

create

POST /addresses

Operation ID: addressCreate.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Request body

application/json

Responses

200: OK - Address successfully created or updated

application/json

Example response:

{
  "details": {
    "city": "Phoenix",
    "country": "US",
    "firstLine": "50 Sunflower Ave",
    "occupations": [
      {
        "code": "Software Engineer",
        "format": "FREE_FORM"
      }
    ],
    "postCode": "10025",
    "state": "AZ"
  },
  "id": 10000001,
  "profile": 12345678
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

list

GET /addresses

Operation ID: addressList.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Responses

200: OK - Successfully retrieved addresses

application/json

Example response:

[
  {
    "details": {
      "city": "Phoenix",
      "country": "US",
      "firstLine": "50 Sunflower Ave",
      "occupations": [
        {
          "code": "Software Engineer",
          "format": "FREE_FORM"
        }
      ],
      "postCode": "10025",
      "state": "AZ"
    },
    "id": 10000001,
    "profile": 12345678
  }
]

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /addresses/{addressId}

Operation ID: addressGet.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Responses

200: OK - Successfully retrieved the address

application/json

Example response:

{
  "details": {
    "city": "Phoenix",
    "country": "US",
    "firstLine": "50 Sunflower Ave",
    "occupations": [
      {
        "code": "Software Engineer",
        "format": "FREE_FORM"
      }
    ],
    "postCode": "10025",
    "state": "AZ"
  },
  "id": 10000001,
  "profile": 12345678
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.