API Reference / Attachments

PATCH /attachments/{attachment_id}

Sets/updates attachment custom file name

Once the custom file name is set it cannot be unset to nil/empty string

Path parameters

Name Type Description
attachment_id req string Attachment ID

Request body

  • attachmentobject
    object fields →
    • custom_filenamestringrequired

      Custom name of the attachment file

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject

    Additional files associated with Deals, Notes, Calls or Meetings. They can be uploaded and stored in S3, or stored in external providers i.e. Google Drive, Dropbox, Evernote.

    object fields →
    • idstringbson-id

      ID of the attachment

    • filenamestringrequired

      Name of the attachment file

    • custom_filenamestring

      Custom name of the attachment file

    • pinnedboolean

      Show if the attachment is pinned to its owner contact

    • pinned_atstring

      Shows pinned at timestamp. Is null if pinned == false

    • sizeintegerint32required

      Size of the attachment file (in bytes)

    • storage_providerstring

      Name of the storage provider (where the attachment file is stored)

      enum: amazon · google_drive · dropbox · evernote

    • urlstring

      External URL of the attachment file

    • url_expires_atstringdate-time

      The time the attachment URL expires

    • thumbnailobject

      An image preview of the attachment file (if one exists)

      object fields →
      • urlstring

        External URL of the attachment's thumbnail

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides