Skip to content
vocapable.Docs

Upload an image for a text (JPEG, PNG or GIF, at most 5 MB)

POST
/v1/mobile/workspace/texting/media
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/workspace/texting/media \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "contact_id": "example", "content_base64": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceMessageMediaUpload

One image for a text to this customer, base64-encoded (at most 5 MB decoded).

The bytes decide its type (JPEG, PNG or GIF); metadata such as a photo’s location is removed before it is stored.

object
contact_id
required
Contact Id
string
content_base64
required
Content Base64
string
>= 4 characters <= 6700000 characters
Examplegenerated
{
  "contact_id": "example",
  "content_base64": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceMessageMedia
object
id
required
Id
string
content_type
required
Content Type
string
size_bytes
required
Any of:
integer
status
required
Status
string
Allowed values: pending stored failed
Example
{
  "status": "pending"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}