SIsignalshq
CLIENT

Update Client Addresses

Set or update primary and mailing addresses for a client.

put/internal/api/clients/{client_identifier}/addresses

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

client_identifierstring required

Request body

same_mailing_addressboolean

Set to true to use primary address as mailing address

Example request

{
  "mailing_address": {
    "address_line_2": "Suite 200",
    "city": "Los Angeles",
    "state": "CA",
    "street_address": "456 Business Blvd",
    "zip_code": "90210"
  },
  "primary_address": {
    "address_line_2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "street_address": "123 Main Street",
    "zip_code": "10001"
  },
  "same_mailing_address": false
}

Response

Successful Response

same_mailing_addressboolean

Indicates if mailing address is same as primary address

Example response

{
  "mailing_address": {
    "address_line_2": "Suite 200",
    "city": "Los Angeles",
    "id": "660f9511-f39c-52e5-b827-557766551111",
    "state": "CA",
    "street_address": "456 Business Blvd",
    "zip_code": "90210"
  },
  "primary_address": {
    "address_line_2": "Apt 4B",
    "city": "New York",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "state": "NY",
    "street_address": "123 Main Street",
    "zip_code": "10001"
  },
  "same_mailing_address": false
}

Changes

No recorded changes to this operation across all 1 revision of this API.