/editContact
1 min
POST
http://1.1.1.1/editContact
Query Parameters
- contact_idstringrequiredExampleDescriptionDefaultcontact_ID
- contact_namestringrequiredExampleDescriptionDefaultcontact name
- request_extra_dataobjectrequiredDescriptionDefault{ "MessageNumber": 5, "SessionId": "3478593863424051983840947" }
- address_group_idsstring[]requiredDescription
- authorization_typestringrequiredExampleDescriptionDefaultINTERNAL
Body Parameters
- bodyeditContactRequest
- FunctionDataobject
- IdstringExampleDescriptionDefault1:0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093
- NamestringExampleDescriptionDefaultcontact name
- AddressGroupIdsstring[]Example
[ "123" ]
Description - AuthorizationTypeintegerExampleDescriptionDefault1
- RequestExtraDataobject
- MessageNumberintegerExampleDescriptionDefault5
- SessionIdstringExampleDescriptionDefault3478593863424051983840947
- MetaMetaTokeneditContact
- FunctionNamestringExampleDescriptionDefaulteditContact
- RandomDatastringExampleDescriptionDefault288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229
- DestinationstringDescriptionDefaultb9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea
- TimestringExampleDescriptionDefault2021-02-07T18:37:46.948Z
- SourcestringDescriptionDefault048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99
- AccessTokenstringExampleDescriptionDefault51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087
Responses
200
- editContactResponse
- FunctionDataobject
- StatusCodeintegerDescriptionDefault0
- MetaMetaResponse
- AccessTokenstringExampleDescriptionDefaulta3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6
- DestinationstringExampleDescriptionDefault042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622
- SourcestringExampleDescriptionDefaultdf4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355
- TimestringExampleDescriptionDefault2021-02-14 09:58:52.320
curl
curl --request POST \
--url 'http://1.1.1.1/editContact?contact_id=contact_ID&contact_name=contact%20name&request_extra_data=%22{%5Cn%20%20%5C%22MessageNumber%5C%22%3A%205%2C%5Cn%20%20%5C%22SessionId%5C%22%3A%20%5C%223478593863424051983840947%5C%22%5Cn}%5Cn%22&address_group_ids=array&authorization_type=INTERNAL' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"FunctionData": {
"Id": "1:0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093",
"Name": "contact name",
"AuthorizationType": 1,
"RequestExtraData": {
"MessageNumber": 5,
"SessionId": "3478593863424051983840947"
}
},
"Meta": {
"FunctionName": "editContact",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"FunctionData": {
"Id": "1:0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093",
"Name": "contact name",
"AuthorizationType": 1,
"RequestExtraData": {
"MessageNumber": 5,
"SessionId": "3478593863424051983840947"
}
},
"Meta": {
"FunctionName": "editContact",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("http://1.1.1.1/editContact?contact_id=contact_ID&contact_name=contact name&request_extra_data=\"{\\n \\\"MessageNumber\\\": 5,\\n \\\"SessionId\\\": \\\"3478593863424051983840947\\\"\\n}\\n\"&address_group_ids=array&authorization_type=INTERNAL", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("http://1.1.1.1/editContact?contact_id=contact_ID&contact_name=contact name&request_extra_data=\"{\n \\"MessageNumber\\": 5,\n \\"SessionId\\": \\"3478593863424051983840947\\"\n}\n\"&address_group_ids=array&authorization_type=INTERNAL")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"FunctionData": {
"Id": "1:0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093",
"Name": "contact name",
"AuthorizationType": 1,
"RequestExtraData": {
"MessageNumber": 5,
"SessionId": "3478593863424051983840947"
}
},
"Meta": {
"FunctionName": "editContact",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
})
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "http://1.1.1.1/editContact?contact_id=contact_ID&contact_name=contact name&request_extra_data=\"{\\n \\\"MessageNumber\\\": 5,\\n \\\"SessionId\\\": \\\"3478593863424051983840947\\\"\\n}\\n\"&address_group_ids=array&authorization_type=INTERNAL"
payload = json.dumps({
"FunctionData": {
"Id": "1:0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093",
"Name": "contact name",
"AuthorizationType": 1,
"RequestExtraData": {
"MessageNumber": 5,
"SessionId": "3478593863424051983840947"
}
},
"Meta": {
"FunctionName": "editContact",
"RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
"Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
"Time": "2021-02-07T18:37:46.948Z",
"Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
"AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// success
{
"FunctionData": {
"StatusCode": 0
},
"Meta": {
"AccessToken": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
"Destination": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
"Source": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
"Time": "2021-02-14 09:58:52.320"
}
}- NOTE - this function can not be called from Swagger, please use editContactForSwagger instead.
- This API allows to edit a contact from the MPC.
- return - success or error response.
- Possible status codes:
0 - Contact edited successfully,
1 - Unknown contact,
2 - Unknown address group,
3 - At most one address group per contact is supported,
4 - Unknown authorization type,
5 - Adding contact to address group leads to overlapping settings in two policies,
6 - Invalid name,
7 - System generated contact cannot be edited,
8 - Smart contract contacts cannot be authorized as internal addresses