Create a text file
POST /api/2.0/crm/{entityType:(contact|opportunity|case)}/{entityid:[0-9]+}/files/text
Request
Creates a text (.txt) file in the selected folder with the title and contents specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization
.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
.- Content-Type
enum of string
Can be one of:
application/json
.
Body
- entityType
string
Related entity type
- entityid
integer
Related entity ID
- title
string
File title
- content
string
File contents
Examples
POST /api/2.0/crm/%7BentityType:(contact%7Copportunity%7Ccase)%7D/%7Bentityid:[0-9]+%7D/files/text HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request POST \
--url 'https://example.com/api/2.0/crm/%7BentityType:(contact%7Copportunity%7Ccase)%7D/%7Bentityid:[0-9]+%7D/files/text' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
File information
- Name
string
- UpdatedBy
object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- Updated
string
- Location
string
401
Unauthorized