Public
Documentation Settings

Contacts_9.8

GETGet Contact

https://am-ce98c.corrigo.com/api/v1/base/Contact/500
AUTHORIZATIONOAuth 2.0
Access Token

<access-token>

HEADERS
CompanyName

RDC CE Sandbox

Example Request
curl
curl --location 'https://am-ce98c.corrigo.com/api/v1/base/Contact/500' \
--header 'CompanyName: RDC CE Sandbox'
200 OK
Example Response
json
{
  "Data": {
    "DisplayAs": "David1 Baldi1 (deleted)",
    "FirstName": "David1",
    "LastName": "Baldi1",
    "TypeId": "Alternate",
    "CustomerId": 0,
    "CanViewAnyRequest": false,
    "CanCreateRequest": false,
    "PriorityThreshold": 255,
    "Username": "DavBaldi",
    "Number": "1",
    "MustResetPassword": false,
    "NoAlertEmails": false,
    "Comment": "Test 2",
    "UnlimitedRequest": false,
    "UnlimitedAuthorization": false,
    "SupervisorId": 0,
    "LanguageId": 0,
    "CustomerNoteAccessId": "View",
    "NoPwdExpirationAlert": false,
    "IsRemoved": true,
    "ConcurrencyId": 3,
    "Id": 500
  }
}
Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Date

Tue, 08 Mar 2022 07:06:24 GMT

Content-Length

493

Strict-Transport-Security

max-age=31536000; includeSubDomains

POSTPost Contact

https://am-ce98c.corrigo.com/api/v1/base/Contact
AUTHORIZATIONOAuth 2.0
Access Token

<access-token>

HEADERS
CompanyName

RDC CE Sandbox

Bodyraw (json)
json
{
 "Entity": {
    "FirstName": "John",
    "LastName": "Doe",
    "TypeId": 3,
    "CustomerId": 371,
    "CanViewAnyRequest": true,
    "CanCreateRequest": true,
    "PriorityThreshold": 255,
    "CustomFields": [],
    "ContactAddresses": [],
    "GroupsBridge": [],
    "Username": "John_doe",
    "Number": "",
    "MustResetPassword": false,
    "NoAlertEmails": false,
    "Comment": "",
    "UnlimitedRequest": false,
    "UnlimitedAuthorization": false,
    "SupervisorId": 0,
    "LanguageId": 0,
    "CustomerNoteAccessId": 2,
    "NoPwdExpirationAlert": false,
    "Currencies": [],
    "IsRemoved": false,
    "ConcurrencyId": 4,
    "Id": 0
  }
}
Example Request
curl
curl --location 'https://am-ce98c.corrigo.com/api/v1/base/Contact' \
--header 'CompanyName: RDC CE Sandbox' \
--data '{
 "Entity": {
    "FirstName": "Test API12",
    "LastName": "API Test2",
    "TypeId": 3,
    "CustomerId": 371,
    "CanViewAnyRequest": true,
    "CanCreateRequest": true,
    "PriorityThreshold": 255,
    "CustomFields": [],
    "ContactAddresses": [],
    "GroupsBridge": [],
    "Username": "API_Test12",
    "Number": "",
    "MustResetPassword": false,
    "NoAlertEmails": false,
    "Comment": "",
    "UnlimitedRequest": false,
    "UnlimitedAuthorization": false,
    "SupervisorId": 0,
    "LanguageId": 0,
    "CustomerNoteAccessId": 2,
    "NoPwdExpirationAlert": false,
    "Currencies": [],
    "IsRemoved": false,
    "ConcurrencyId": 4,
    "Id": 0
  }
}
'
200 OK
Example Response
json
{
  "EntitySpecifier": {
    "ConcurrencyId": 1,
    "EntityType": "Contact",
    "Id": 25185
  }
}
Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Date

Tue, 08 Mar 2022 07:07:18 GMT

Content-Length

73

Strict-Transport-Security

max-age=31536000; includeSubDomains

PUTPut Contact

https://am-ce98c.corrigo.com/api/v1/base/Contact
AUTHORIZATIONOAuth 2.0
Access Token

<access-token>

HEADERS
CompanyName

RDC CE Sandbox

Bodyraw (json)
json
{
                "Properties" : ["*"] ,
                "Entity":
                {
                             "Id": 500,
                     "Comment": "Test 2",
                     "FirstName": "David1",
                     "LastName": "Baldi1",
                     "UserName":"DavBaldi",
                     "Number": "1",
                     "CustomerNoteAccessid":"View"
                }
}
Example Request
curl
curl --location --request PUT 'https://am-ce98c.corrigo.com/api/v1/base/Contact' \
--header 'CompanyName: RDC CE Sandbox' \
--data '{
                "Properties" : ["*"] ,
                "Entity":
                {
                             "Id": 500,
                     "Comment": "Test 2",
                     "FirstName": "David1",
                     "LastName": "Baldi1",
                     "UserName":"DavBaldi",
                     "Number": "1",
                     "CustomerNoteAccessid":"View"
                }
}
'
200 OK
Example Response
json
{
  "EntitySpecifier": {
    "ConcurrencyId": 3,
    "EntityType": "Contact",
    "Id": 500
  }
}
Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Date

Tue, 08 Mar 2022 07:07:44 GMT

Content-Length

71

Strict-Transport-Security

max-age=31536000; includeSubDomains

DELETEDelete Contact

https://am-ce98c.corrigo.com/api/v1/base/Contact/500?
AUTHORIZATIONOAuth 2.0
HEADERS
CompanyName

RDC CE Sandbox

PARAMS
Example Request
curl
curl --location --request DELETE 'https://am-ce98c.corrigo.com/api/v1/base/Contact/500?=null' \
--header 'CompanyName: RDC CE Sandbox'
200 OK
Example Response
json
{
  "EntitySpecifier": {
    "EntityType": "Contact",
    "Id": 500
  }
}
Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Date

Tue, 08 Mar 2022 07:08:07 GMT

Content-Length

53

Strict-Transport-Security

max-age=31536000; includeSubDomains