Skip to end of banner
Go to start of banner

GET contact_information/validate_address_pobox_post_code

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

This method returns if the address post code is in a valid format

Available from CRM.COM R15.0.0

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

address_type

(mandatory)

String

The address type for which the post code is validated

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

country_identifier

(mandatory)

Country identifier

The country of the address which the post code is validated. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

pobox_post_code_number

(mandatory)

StringThe po box post code number which is validated

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Multiple semi-optional parameters can be specified in each call

Response Data

Name

Type

Description

boolean

String

Defines if the address po box post code is in valid format or not

 

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

   
  • No labels