contacts

Contact points related operations

Creates a contact point

post

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

contact_formstringoptional

The contact point's contact form

emailstringrequired

The contact point's email

idstringread-onlyoptional

The contact point's identifier

namestringrequired

The contact point's name

organizationall ofoptional

The producer organization

ownerall ofoptional

The user information

rolestringrequired

The role of the contact

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://www.data.gouv.fr/api/1/contacts/' \
  --header 'Content-Type: application/json' \
  --data '{
    "contact_form": "text",
    "email": "text",
    "name": "text",
    "organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "slug": "text"
    },
    "owner": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "slug": "text",
      "uri": "text"
    },
    "role": "text"
  }'

application/json

200

400

200

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  },
  "role": "text"
}

Success

Deletes a contact point given its identifier

delete

Path parameters

contact_pointanyrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://www.data.gouv.fr/api/1/contacts/{contact_point}/'

204

404

204

No body

Contact point deleted

Get a contact point given its identifier

get

Path parameters

contact_pointanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://www.data.gouv.fr/api/1/contacts/{contact_point}/'

200

404

200

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  },
  "role": "text"
}

Success

parameters

Path parameters

contact_pointanyrequired

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PARAMETERS \
  --url 'http://www.data.gouv.fr/api/1/contacts/{contact_point}/'

Updates a contact point given its identifier

put

Path parameters

contact_pointanyrequired

Header parameters

X-Fieldsanyoptional

An optional fields mask

Body

contact_formstringoptional

The contact point's contact form

emailstringrequired

The contact point's email

idstringread-onlyoptional

The contact point's identifier

namestringrequired

The contact point's name

organizationall ofoptional

The producer organization

ownerall ofoptional

The user information

rolestringrequired

The role of the contact

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://www.data.gouv.fr/api/1/contacts/{contact_point}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "contact_form": "text",
    "email": "text",
    "name": "text",
    "organization": {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "slug": "text"
    },
    "owner": {
      "class": "text",
      "id": "text",
      "avatar": "text",
      "avatar_thumbnail": "text",
      "slug": "text",
      "uri": "text"
    },
    "role": "text"
  }'

application/json

200

400

404

200

{
  "contact_form": "text",
  "email": "text",
  "id": "text",
  "name": "text",
  "organization": {
    "class": "text",
    "id": "text",
    "acronym": "text",
    "logo": "text",
    "logo_thumbnail": "text",
    "slug": "text"
  },
  "owner": {
    "class": "text",
    "id": "text",
    "avatar": "text",
    "avatar_thumbnail": "text",
    "slug": "text",
    "uri": "text"
  },
  "role": "text"
}

Success