PUT /api/tenants/{FedmemberID}/countrycodes

Adds or updates the list of telephone country codes that will be supported for telephone numbers in user profiles.

Note: In version 2020.1.0, country names are supported as well as the numeric telephone dialing codes. It's best to upgrade your data to include country names as well as codes. If provided, country names are displayed in the Community Manager developer portal user interface.

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for the tenant; Site Admin.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/tenants/{FedmemberID}/countrycodes

Sample Request

The examples below shows requests to add one or more country codes.

Sample Request URL

https://{hostname}/api/tenants/acmepaymentscorp/countrycodes

Sample request headers

Accept: application/json
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body #1: one country (versions up to 2020.1.0)

Adds country code for the United States and Canada.

{
  "CountryCode":[
    {
      "id":"+1"
    }
  ]
}

Sample request body #2: multiple countries (versions up to 2020.1.0)

Adds country codes for the United States and Canada, Ireland, United Kingdom, and India.

{
  "CountryCode":[
    {
      "id":"+1"
    },
    {
      "id":"+353"
    },
    {
      "id":"+44"
    },
    {
      "id":"+91"
    }
  ]
}

Sample request body #3: one country (valid in version: 2020.1.0 and later)

Adds country code for the United States and Canada.

{
  "CountryCode":[
    {
    "id": "+1",
    "Name": "United States and Canada"
    }
  ]
}

Sample request body #4: multiple countries (valid in version: 2020.1.0 and later)

Adds country codes for the United States and Canada, Ireland, United Kingdom, Jersey, and India.

[
  {
    "id": "+1",
    "Name": "United States and Canada"
  },
  {
    "id": "+353",
    "Name": "Ireland"
  },
  {
    "id": "+44",
    "Name": "United Kingdom"
  },
  {
    "id": "44-1534",
    "Name": "Jersey"
  },
  {
    "id": "91",
    "Name": "India"
  }
]

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
FedmemberID	Path	String	Required	Unique ID for a specific tenant. Same as TenantID.
CountryCodes	Body	CountryCodes	Required	Contains information about the telephone country codes supported on the platform.

Response

If successful, this operation returns HTTP status code 200. There is no response body.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers:

Status Code: 200 OK
Date: Wed, 04 Mar 2020 21:28:22 GMT

Sample response body

None.

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

None.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb. For example, you would get this error if you used POST instead of PUT.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics