Sign in
Attachment

Update an attachment

Updates the attachment identified by the specified token.

put/attachment/{token}

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

x-api-languagestring[]

Defines the languages included in the response. If omitted, the account default language is used.

Value all overrides any other values present.

Request body

attachment_fieldsobject

Values for the form fields captured against this attachment, keyed by field slug.

Each value must conform to the type of the corresponding field on the parent attachments tab; for example, a text field accepts a string, a choice field accepts the slug of one of its options, and a number field accepts a numeric value.

Field slugs that do not exist on the parent tab are rejected.

orderinteger

Position of the attachment within its tab. Lower values sort earlier.

tabstring

Slug of the tab to move the attachment to.

Must reference a tab whose type is Attachments; tabs of other types are rejected.

Response

Attachment updated.

createdstring date-time

Time the attachment was created.

orderinteger

Position of the attachment within its tab.

tokenstring

Token identifying the attachment file. Same value as file.token.

updatedstring date-time

Time the attachment was last updated.

Example response

{
  "entry": {
    "slug": "AbCdEfGh",
    "link": "https://api.au.cr4ce.com/entry/AbCdEfGh",
    "title": "Project title"
  },
  "attachment_fields": [
    {
      "slug": "IjKlMnOp",
      "link": "https://api.au.cr4ce.com/field/IjKlMnOp",
      "label": {
        "en_GB": "Type of attachment"
      },
      "title": {
        "en_GB": "Type of attachment"
      },
      "value": "Photo",
      "translated": {
        "en_GB": "Photo"
      }
    },
    {
      "slug": "QrStUvWx",
      "link": "https://api.au.cr4ce.com/field/QrStUvWx",
      "label": {
        "en_GB": "<p>URL</p>"
      },
      "title": {
        "en_GB": "URL"
      },
      "value": "https://example.com/image.svg",
      "translated": {
        "en_GB": "https://example.com/image.svg"
      }
    }
  ],
  "created": "2025-04-27T01:00:00Z",
  "file": {
    "token": "AbCdEfGhIjKlMnOp",
    "link": "https://api.au.cr4ce.com/file/AbCdEfGhIjKlMnOp",
    "download": "https://files.au.cr4ce.com/file/AbCdEfGhIjKlMnOp/example.pdf?Expires=1781485359&Signature=REDACTED&Key-Pair-Id=REDACTED",
    "filename": "example.pdf"
  },
  "order": 1,
  "tab": {
    "slug": "YzAbCdEf",
    "link": "https://api.au.cr4ce.com/tab/YzAbCdEf",
    "name": {
      "en_GB": "Attachments"
    }
  },
  "token": "AbCdEfGhIjKlMnOp",
  "updated": "2025-04-27T01:05:00Z"
}

Changes