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 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:

Include Page
V4:country_identifier
V4:country_identifier

pobox_post_code_number

(mandatory)

StringThe po box post code number which is validated

...

Expand
titleExample 1

HTTP Method: GET

 

Request:

Response:

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