Loading ...

REST API: Update Address | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Update Address
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 19

REST API: Update Address

0 
 /5
0 (0votes)

Note This API has been deprecated. For 6.0 and above sites, use REST API: Update User Profile Fields .

Update User Address

PUT /api/users/{UserID}/address/default

Update address fields for an existing user specified by user ID. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
UserID Used in the request URL as a path parameter and in the request body Unique identifier for a particular user.
User JSON Used in the request body This is JSON that represents a user object that you're updating. This should be of the format seen below in the given sample.
Optional Parameters How to use Description
Address1 Used in the request body Address 1 of the user.
Address2 Used in the request body Address 2 of the user.
PostalCode Used in the request body Postal code of user's location.
Country Used in the request body Country where the user belongs. (For v6.0+)
State Used in the request body State where the user belongs. (For v6.0+)
CountryID Used in the request body Unique ID of the country from where user belongs. (For v5.2)
StateID Used in the request body Unique ID of the state from where user belongs. (For v5.2)
FaxNumber Used in the request body Fax number of the user.
PhoneNumber Used in the request body Phone number of the user.

Example Request

PUT https://myintranet.communifire.com/api/users/13/address/default


"{\"UserID\":\"26\",\"Address1\":\"123 Mission St\",\"Address2\":\"Unit 1\",\"StateID\":\"5\",\"CountryID\":\"1\",\"PostalCode\":\"33606\",\"PhoneNumber\":\"1234567890\",\"FaxNumber\":\"1234567890\"}"

Note: Stringify your JSON data.

Example Response

User ID is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"True",
    "ResponseData":13
}


Please Note The content type that you pass in the header of your request should be application/json.

State IDs (For v5.2)

StateID StateName
1 Alabama
2 Alaska
3 Arizona
4 Arkansas
5 California
6 Colorado
7 Connecticut
8 Delaware
9 District of Columbia
10 Florida
11 Georgia
12 Hawaii
13 Idaho
14 Illinois
15 Indiana
16 Iowa
17 Kansas
18 Kentucky
19 Louisiana
20 Maine
21 Maryland
22 Massachusetts
23 Michigan
24 Minnesota
25 Mississippi
26 Missouri
27 Montana
28 Nebraska
29 Nevada
30 New Hampshire
31 New Jersey
32 New Mexico
33 New York
34 North Carolina
35 North Dakota
36 Ohio
37 Oklahoma
38 Oregon
39 Pennsylvania
40 Rhode Island
41 South Carolina
42 South Dakota
43 Tennessee
44 Texas
45 Utah
46 Vermont
47 Virginia
48 Washington
49 West Virginia
50 Wisconsin
51 Wyoming
54 Confidential

Country IDs (For v5.2)

For a list of Country IDs, click here.

Attachments

Wiki Index

Pages

Intranet Software