Delete a contact.

delete https://qa.connect.calamp.com/connect/services/contacts/{id}

Removes contact and phones.

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

int64

Required for PUT requests with resource object in the request body. Forbidden for POST requests with resource object in the request body. Will result in an HTTP 400 - Bad Request response.

title

string

Title of the Contact. Max Length = 64 characters

description

string

Description of the contact. Max Length = 255 characters

string

Valid value required if 'notify' property is set to true on contact. Max Length = 256 characters

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

lastName

string

Last Name of Contact. Max Length = 64 characters

firstName

string

First Name of contact. Max Length = 64 characters

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

phoneNumbers

array of objects

List of phoneNumbers for the Contact.

phoneNumbers

object

extension

string

The an extension to be dialed after main number. Max length = 6 characters

phoneNumber

string

required

Max length = 32 characters

phoneType

string

required

WORK CELL FAX TOLL_FREE

addresses

array of objects

List of addresses for the Contact.

addresses

object

country

string

Name of the country. Max length = 64 characters

block

string

subdistrict

string

subblock

string

houseNumber

string

street2

string

The street2 address. Max length = 128 characters

city

string

required

Required along with StateProvinceCd if a Zip is not provided. Max length = 64 characters

stateProvince

string

Name of the state/province. Max length = 64 characters

countryCd

string

The international country code. If not specified, default 'US' is used. Max length = 3 characters

zip

string

required

Either this field or the City+State fields should be provided for a valid address. Max length = 10 characters

street

string

The street address, including house number. Max length = 128 characters

district

string

stateProvinceCd

string

Required along with City if a Zip is not provided. Max Length = 8 characters.

addressType

string

required

BILLING MAILING SHIPPING

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

403

Not authorized for this operation.

404

Contact not found.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://qa.connect.calamp.com/connect/services/contacts/id \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200successful operation