Skip to content
digizeDocs

Message a contact

POST
/api/v1/conversations
curl --request POST \
  --url https://digize.com/api/v1/conversations \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "contactId": "example", "channel": "sms", "subject": "example", "body": "example" }'

Texts or emails a contact, in their conversation on that channel or a new one. Texts go from the workspace’s Twilio number; email needs a sending domain and is refused until there is one. Refused for a contact who replied STOP.

Needs the crm:write permission. It can’t be undone.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example 

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
contactId
required
string
>= 1 characters <= 64 characters
channel
required
string
Allowed values: sms email
subject
string
<= 200 characters
body
required
string
>= 1 characters <= 20000 characters

Responses

Section titled “Responses”

201

Section titled “201”

Done

Media typeapplication/json
object
conversation
required
object
id
required
string
contact
required
object
id
required
string
name
required
string
firstName
required
string
email
required
string | null
phone
required
string | null
channel
required
string
Allowed values: sms email
address
required

The workspace’s number or address the contact writes to.

string
subject
required

Emails only.

string | null
status
required
string
Allowed values: open closed
assigneeId
required

The member answering it, by user id.

string | null
unread
required
boolean
lastMessage
required
Any of:
object
kind
required
string
Allowed values: message call
direction
required
string
Allowed values: in out
authorKind
required
string
Allowed values: contact team automation system
body
required

The start of it, on one line.

string
status
required
string
Allowed values: pending queued sent delivered failed undelivered received
sentAt
required
string format: date-time
lastMessageAt
required
string format: date-time
optedOut
required

A text conversation whose contact replied STOP: nothing can be texted to them until they reply START.

boolean
createdAt
required
string format: date-time
message
required
object
id
required
string
conversationId
required
string
kind
required

A text or email, or a call to one of the workspace’s numbers.

string
Allowed values: message call
direction
required
string
Allowed values: in out
author
required
One of:
object
kind
required
string
Allowed value: contact
from
required
string
to
required
string
subject
required
string | null
body
required
string
status
required

Pending until Twilio takes it, then queued, sent and delivered, or failed or undelivered; received for one that came in.

string
Allowed values: pending queued sent delivered failed undelivered received
error
required

Why it didn’t go.

string | null
attachments
required
Array<object>
object
name
required
string
type
required
string
size
required
number
url
required

A signed link that works for an hour.

string | null
fullEmailUrl
required

The whole email, when it was too long to show here.

string | null
call
required
Any of:
object
status
required
string
Allowed values: ringing answered completed missed voicemail failed
durationSeconds
required
number
recording
required
Any of:
object
kind
required
string
Allowed values: voicemail call
status
required
string
Allowed values: pending stored absent failed
seconds
required
number | null
url
required
string | null
sentAt
required
string format: date-time

Example 

{
  "conversation": {
    "channel": "sms",
    "status": "open",
    "lastMessage": {
      "kind": "message",
      "direction": "in",
      "authorKind": "contact",
      "status": "pending"
    }
  },
  "message": {
    "kind": "message",
    "direction": "in",
    "author": {
      "kind": "contact"
    },
    "status": "pending",
    "call": {
      "status": "ringing",
      "recording": {
        "kind": "voicemail",
        "status": "pending"
      }
    }
  }
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

409

Section titled “409”

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

422

Section titled “422”

The Idempotency-Key was used with a different request.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}