POST api/v1/portals/{portalUid}/customer/countries
Creates the country for a specified portal UID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalUid |
The portal UID. |
globally unique identifier |
Required |
Body Parameters
The country.
Country| Name | Description | Type | Additional information |
|---|---|---|---|
| Iso3Code |
The country ISO3 code e.g. GBR, ESP, FRA. |
string |
Required String length: inclusive between 0 and 3 |
| Name |
The country name. |
string |
Required String length: inclusive between 0 and 50 |
Request Formats
application/json, text/json
Sample:
{
"Iso3Code": "sample string 1",
"Name": "sample string 2"
}
application/xml, text/xml
Sample:
<Country xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models"> <Iso3Code>sample string 1</Iso3Code> <Name>sample string 2</Name> </Country>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the created country.
CountryViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Iso3Code |
The country ISO3 code. |
string |
None. |
| Name |
The country name. |
string |
None. |
| Portal |
The portal. |
PortalViewModel |
None. |
| CountryGuid |
The unique identifier for the country |
globally unique identifier |
None. |
| Uid |
The GUID. |
globally unique identifier |
None. |
| Links |
The links. |
Collection of Link |
None. |
| DateUpdated |
Last time the record was updated |
date |
None. |
| UpdatedBy |
Who updated the record last |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Iso3Code": "sample string 1",
"Name": "sample string 2",
"Portal": {
"Name": "sample string 1",
"Uid": "df0f80d4-b68f-4c7d-ac0f-2d25a9aac253",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T14:01:42.7649009+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "0619ca27-24f3-4708-9f46-f7b00dd6e9c1",
"Uid": "794ff62e-07b6-485b-975c-a0a6eeacefb9",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T14:01:42.7649009+00:00",
"UpdatedBy": "sample string 5"
}
application/xml, text/xml
Sample:
<CountryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-10-27T14:01:42.7649009+00:00</DateUpdated>
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
</Links>
<Uid>794ff62e-07b6-485b-975c-a0a6eeacefb9</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>0619ca27-24f3-4708-9f46-f7b00dd6e9c1</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-10-27T14:01:42.7649009+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>df0f80d4-b68f-4c7d-ac0f-2d25a9aac253</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</CountryViewModel>