Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

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

Tip

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 validatedaddress_country

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

country_identifier

(mandatory)

String

Country identifier

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

Include Page
V4:country_identifier
V4:country_identifier

post_code_number

(mandatory)

StringThe value of the post code number which is validated

Restrictions

...

Name

Type

Description

boolean

String

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

 

Examples

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
    {
    "data": {
        "is_valid": true
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}