Contacts

Création d'un contact

post

Création d'un contact

Authorizations

basicAuth

AuthorizationstringRequired

Body

application/json

anyOptional

Responses

200

Opération réalisée avec succès

application/json

idnumberOptionalExample: 1

warningstringOptional

post

/contacts

HTTPcURLJavaScriptPython

POST /rest/contacts HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 337

{
  "firstname": "Cédric",
  "lastname": "Rouire",
  "company": "Edissyum Consulting",
  "function": "CEO",
  "department": "Direction de la société",
  "email": "[e-mail]",
  "phone": "0490409186",
  "addressNumber": "98",
  "addressStreet": "Avenue Pierre Semard",
  "addressPostCode": "84200",
  "addressTown": "Carpentras",
  "addressCountry": "France",
  "civility": 1
}

200

Opération réalisée avec succès

{
  "id": 1,
  "warning": ""
}

Recherche de contacts

post

Recherche de contacts

Authorizations

basicAuth

AuthorizationstringRequired

Body

application/json

Responses

200

Opération réalisée avec succès

application/json

post

/searchContacts

HTTPcURLJavaScriptPython

POST /rest/searchContacts HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "meta": {
    "values": "YOUR_SEARCH"
  }
}

200

Opération réalisée avec succès

{
  "contacts": [
    {
      "contact_id": 4,
      "firstname": "Nicolas",
      "lastname": "MARTIN",
      "email": "Préfecture de MEM EN PROVENCE",
      "phone": "Préfecture de MEM EN PROVENCE",
      "addressNumber": "98",
      "addressStreet": "Avenue Pierre Semard",
      "addressAdditional1": "Société EDISSYUM",
      "addressAdditional2": null,
      "addressPostcode": "84200",
      "addressTown": "Préfecture de MEM EN PROVENCE",
      "addressCountry": "FRANCE",
      "customFields": {
        "3": "Courrier simple"
      }
    }
  ]
}

Récupération de la liste des contacts

get

Récupération de la liste des contacts

Authorizations

basicAuth

AuthorizationstringRequired

Responses

200

Opération réalisée avec succès

application/json

get

/contacts

HTTPcURLJavaScriptPython

GET /rest/contacts HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "contacts": [
    {
      "id": 1,
      "firstname": "Nicolas",
      "lastname": "MARTIN",
      "company": "Préfecture de MEM EN PROVENCE",
      "addressNumber": "13",
      "addressStreet": "RUE LA PREFECTURE",
      "custom_fields": [],
      "addressAdditional1": "BP 12345",
      "addressAdditional2": "3ème étage",
      "addressPostcode": "84200",
      "addressTown": "MEM-EN-PROVENCE",
      "addressCountry": "FRANCE",
      "enabled": true,
      "sector": "Direction des Richesses Humaines",
      "count": 70,
      "email": "[e-mail]",
      "externalId": {
        "m2M": "45239273100025/COU"
      },
      "isUsed": true,
      "filling": {
        "rate": 61.54,
        "thresholdLevel": "second"
      }
    }
  ]
}

Récupération d'un contact par identifiant

get

Récupération d'un contact par identifiant

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

contact_idstringRequiredExample: 1

Responses

200

Opération réalisée avec succès

application/json

idnumberOptionalExample: 1

firstnamestringOptionalExample: Nicolas

lastnamestringOptionalExample: MARTIN

companystringOptionalExample: Préfecture de MEM EN PROVENCE

addressNumberstringOptionalExample: 13

addressStreetstringOptionalExample: RUE LA PREFECTURE

custom_fieldsarrayOptional

addressAdditional1stringOptionalExample: BP 12345

addressAdditional2stringOptionalExample: 3ème étage

addressPostcodestringOptionalExample: 84200

addressTownstringOptionalExample: MEM-EN-PROVENCE

addressCountrystringOptionalExample: FRANCE

enabledbooleanOptionalExample: true

sectorstringOptionalExample: Direction des Richesses Humaines

countnumberOptionalExample: 70

emailstringOptionalExample: [e-mail]

externalIdobjectOptionalExample: {"m2M":"45239273100025/COU"}

isUsedbooleanOptionalExample: true

fillingobjectOptionalExample: {"rate":61.54,"thresholdLevel":"second"}

get

/contacts/{contact_id}

HTTPcURLJavaScriptPython

GET /rest/contacts/{contact_id} HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "id": 1,
  "firstname": "Nicolas",
  "lastname": "MARTIN",
  "company": "Préfecture de MEM EN PROVENCE",
  "addressNumber": "13",
  "addressStreet": "RUE LA PREFECTURE",
  "custom_fields": [],
  "addressAdditional1": "BP 12345",
  "addressAdditional2": "3ème étage",
  "addressPostcode": "84200",
  "addressTown": "MEM-EN-PROVENCE",
  "addressCountry": "FRANCE",
  "enabled": true,
  "sector": "Direction des Richesses Humaines",
  "count": 70,
  "email": "[e-mail]",
  "externalId": {
    "m2M": "45239273100025/COU"
  },
  "isUsed": true,
  "filling": {
    "rate": 61.54,
    "thresholdLevel": "second"
  }
}

Récupération des contacts par mail

get

Récupération des contacts par mail

Authorizations

basicAuth

AuthorizationstringRequired

Query parameters

mailstringOptionalExample: YOUR_MAIL

Responses

200

Opération réalisée avec succès

application/json

idnumberOptionalExample: 1

get

/getContactByMail

HTTPcURLJavaScriptPython

GET /rest/getContactByMail HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "id": 1
}

Récupération des contacts par téléphone

get

Récupération des contacts par téléphone

Authorizations

basicAuth

AuthorizationstringRequired

Query parameters

phonestringOptionalExample: YOUR_PHONE

Responses

200

Opération réalisée avec succès

application/json

idnumberOptionalExample: 1

get

/getContactByPhone

HTTPcURLJavaScriptPython

GET /rest/getContactByPhone HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "id": 1
}

Récupération des courriers par contact

get

Récupération des courriers par contact

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

contact_idstringRequiredExample: 1

Query parameters

selectstringOptionalExample: r.res_id, r.subject, r.creation_date, r.modification_date, r.status

Responses

200

Opération réalisée avec succès

application/json

get

/resources/getByContact/{contact_id}

HTTPcURLJavaScriptPython

GET /rest/resources/getByContact/{contact_id} HTTP/1.1
Host: demo.memcourrier.com
Authorization: Basic username:password
Accept: */*

200

Opération réalisée avec succès

{
  "resources": [
    {
      "res_id": 100,
      "subject": "Courrier de tests",
      "alt_identifier": "2025D/00001",
      "creation_date": "2020-07-31 14:49:47.16597",
      "modification_date": "2020-07-31 14:49:47.16597",
      "status": "NEW"
    }
  ]
}