attachments · startUpload

Authorization

bearerAuth

AuthorizationBearer <token>

An API key from Settings → Connect to Agents, or an OAuth access token. Never the session cookie.

In: header

Path Parameters

orgSlug*string

The workspace. Membership is what authorizes it.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

resourceType*string

Value in

"company"
"person"
"opportunity"
"meeting"
"task"

resourceId*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

filename*string

Length1 <= length <= 255

contentType*string

Length1 <= length

size*integer

Range0 < value <= 9007199254740991

Response Body

`application/json`

curl -X POST "https://example.com/string/attachments/startUpload" \  -H "Content-Type: application/json" \  -d '{    "resourceType": "company",    "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",    "filename": "string",    "contentType": "string",    "size": 1  }'

{  "ok": true,  "data": null}

attachments · startUpload

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`