API Reference / Attachments

GET /attachments/s3_form

Get a pre-authorized S3 upload form (use to upload a file on the client side)

Files must be uploaded to S3 before they can be attached to deals, notes, calls or meetings, and this request returns everything needed for that upload. Send a POST request to the URL in the response and include every param from the fields construct as form fields of that upload. Most can be sent as they are, but key must be constructed as {contact_id}/{timestamp}/{filename}, the filename field must match the filename at the end of key, and file is the file to upload. After a successful upload the file can be attached. Maximum file size is 10 MB; each account has 1 GB of storage per user. Additional information on the upload process: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-post-example.html

Query parameters

Name Type Description
contact_id req string Contact to be associated with the attachment

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • quotaany
    • display_quotaany
    • urlany
    • fieldsobject
      object fields →
      • keyany
      • x-ignore-patternany
      • aclany
      • success_action_statusany
      • policyany
      • x-amz-algorithmany
      • x-amz-credentialany
      • x-amz-dateany
      • x-amz-signatureany

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

Related guides