Contacts

Covage allows you to save a company contact list to avoid having to enter the contact information each time an order is placed.

The contacts API allows you to list, create, modify and delete your contacts.

Object fields

Field name	Type	Description
contact_uuid	string	Contact technical identifier (automatically assigned)
first_name	string	First name
last_name	string	Last name
phone_number	dictionary	Fixed-line number
cell_phone_number	dictionary	Mobile phone number
email	endpoint list	Email

{
    "contact_uuid": "i9usbs1j",
    "first_name": "Patrick",
    "last_name": "Bousso",
    "phone_number": "0130530396",
    "cell_phone_number": "0699437892",
    "email": "patrick.bousso@colibrix.fr"
}

Retrieving a contact

To retrieve a contact, you can do GET on the /api/contacts/{contact_uuid}/ URL.

Example:

GET /api/contacts/i9usbs1j/ HTTP/1.1
Host: extranet.kosc-telecom.fr

HTTP/1.1 200 OK
Content-Type: application/json

{
    "contact_uuid": "i9usbs1j",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "0142845403",
    "cell_phone_number": "0692417900",
    "email": "john@doe.com"
}

Deleting a contact

To delete a contact, you can do DELETE on the /api/contacts/{contact_uuid}/ URL.

Example:

DELETE /api/contacts/i9usbs1j/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Creating a contact

To create a contact, you can do POST on the /api/contacts/ URL.

Example:

POST /api/contacts/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "0142845403",
    "cell_phone_number": "0692417900",
    "email": "john@doe.com"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "contact_uuid": "i9usbs1j",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "0142845403",
    "cell_phone_number": "0692417900",
    "email": "john@doe.com"
}

Note

The information in full has to be sent to the server.

Modifying a contact

To modify a contact, you can do PUT on the /api/contacts/{contact_uuid}/ URL.

Example:

PUT /api/contacts/i9usbs1j/ HTTP/1.1
Host: extranet.kosc-telecom.fr
Content-Type: application/json

{
    "contact_uuid": "i9usbs1j",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "0142845403",
    "cell_phone_number": "0692417900",
    "email": "john@doe.com"
}

Note

The information in full has to be sent to the server.

Listing the contacts

To retrieve your contact list, you can do GET on the /api/contacts/ URL.

GET /api/contacts/ HTTP/1.1
Host: extranet.kosc-telecom.fr

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "contact_uuid": "i9usbs1j",
        "first_name": "John",
        "last_name": "Doe",
        "phone_number": "0142845403",
        "cell_phone_number": "0692417900",
        "email": "john@doe.com"
    },
    {
        "contact_uuid": "28ur020o",
        "first_name": "Jane",
        "last_name": "Dale",
        "phone_number": "0432244493",
        "cell_phone_number": "0674830292",
        "email": "jane@dale.com"
    },
]