PUT /api/tenants/{FedmemberID}/countrycodes

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

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

Back to top

URL

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

Back to top

Sample Request

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

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

Adds country code for the USA.

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

Sample request body #2: multiple countries

Adds country codes for the USA, England, India, and Ireland.

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

Back to top

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

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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
FedmemberID Path String Required Unique ID for a specific tenant, in a federation (multi-tenant) scenario; for example, acmepaymentscorp.
CountryCodes Body CountryCodes Required Contains information about the telephone country codes supported on the platform.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers:

Status Code: 200 OK
Expires: Wed, 07 Oct 2015 13:28:08 GMT

Sample response body

None.

Back to top

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

Back to top

Response Body

None.

Back to top

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics