Address and phone objects

Address and phone information isn't required to create an account on the Pismo platform. You can, however, add and manage addresses and phone numbers on an account with the following endpoints at any time.

Pismo stores all addresses and phone numbers ever associated with an account. To delete an address or phone number from the account, use the Update address or Update phone information endpoint and set the is_active parameter to false.

Address

An account can have multiple addresses, but only one address on the account can have mailing_address set as true.

  • Create address: To add an address to an account, use the Create address endpoint with the accountId path parameter and the required body parameters.
  • List addresses: To list all addresses linked to an account, use the List addresses endpoint. You can filter on active addresses with the active query parameter set to true.
  • Get address: To get details of a specific address linked to an account, first find the address ID using the List addresses endpoint and then use it in the Get address endpoint.
  • Update address: To update information for an address, use the Update address endpoint.
  • Delete address: To delete an address, use the Update address endpoint and set is_active to false.

Phone

An account can have multiple phone numbers.

  • Create phone: To add a phone number to an account, use the Create phone endpoint with the accountId path parameter and the required body parameters.
  • List phones: To list all phone numbers for a given account, use the List phones endpoint.
  • Get phone information: To get details for a specific phone number, use the List phones endpoint to obtain the phone ID and then use it in the Get phone information endpoint.
  • Update phone information: To update details for a specific phone number, use the Update phone information endpoint.
  • Delete phone number: To delete a phone number, use the Update phone information endpoint and set is_active to false.