API Reference

Attach a document to a lead

put
https://company_subdomain.talkpush.com/api/talkpush_services/campaign_invitations//documents

With this endpoint you can attach a document to a lead. A document tag Id or Name are needed to attach the file to a lead.

Path Params
integer
required

Lead ID

Query Params
string
required

The API key provided for your application

integer

Document Tag ID. Required if no Document Tag name parameter is used. If sending a Document Tag ID, this is prioritized to search for an existing Document Tag, if it doesn't exist, the respose will be not found and fail to attach a file to the lead.

string

Document Tag Name. Not required unless no Document Tag ID is used. If sending this parameter, a Document Tag ID must not be sent since it's prioritized over the name. If the Document Tag with the name sent is not found, a new Document Tag will be created with the name sent.

Body Params
file
required

File to be attached to the lead as form-data. It can be sent as raw binary data or a file URL.

Responses
200

Document attached successfully to candidate

400

Bad request. Please make sure that no invalid parameters were provided.

404

Campaign Invitation or Document Tag not found.

500

Internal server error, we will provide you with the exception message.

Updated about 1 year ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 1 year ago