Update a Destination by ID

PUT

https://api.contentful.com/spaces/:spaceId/environments/:environmentId/destinations/:destinationId

PUT

/spaces/:spaceId/environments/:environmentId/destinations/:destinationId

curl -X PUT https://api.contentful.com/spaces/yadj1kx9rmg0/environments/master/destinations/4RqKkGJqLHpMiomHuILv5N \
     -H "X-Contentful-Version: 1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "name": "Website",
  "description": "Primary website destination",
  "properties": [
    {
      "id": "baseUrl",
      "value": "value"
    }
  ]
}'

200Updated

{
  "name": "name",
  "description": "description",
  "properties": [
    {
      "id": "baseUrl",
      "value": "value"
    }
  ],
  "sys": {
    "channel": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "createdAt": "createdAt",
    "createdBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "environment": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "firstPublishedAt": "firstPublishedAt",
    "id": "id",
    "publishedAt": "publishedAt",
    "publishedBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "publishedCounter": 1,
    "publishedVersion": 1,
    "space": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "type": "Destination",
    "updatedAt": "updatedAt",
    "updatedBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "version": 1
  }
}

Replaces the name, description, and properties of a Destination. The Channel is fixed when the Destination is created, so channelId must not be sent.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

ID of the space.

environmentIdstringRequired

ID of the environment.

destinationIdstringRequired

ID of the Destination.

Request

This endpoint expects an object.

namestringRequired

descriptionstringRequired

propertieslist of objectsRequired

Response

OK - Destination updated

namestring

descriptionstring

propertieslist of objects

sysobject

Authentication

Path parameters

Headers

Request

Response