Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Updated Mon Feb 6th 2023, 19:36 UTC

Assign Contact

PUT /conversations/:conversation/assign_contact

If you have multiple Contacts in your Account with the same Phone Number, it is ambiguous which Contact is having the Conversation. Assignment allows you to assign the preferred Contact to the Conversation.

Examples

User makes a request to assign the contact to the conversation

Request

PUT /conversations/Pvwqm5G/assign_contact

Body

{ "assigned_contact": "<%= contact_path(@contact) %>" }
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X PUT /conversations/Pvwqm5G/assign_contact
    -d '{ "assigned_contact": "<%= contact_path(@contact) %>" }'

Response

Status

200

Response Type

Conversation

Example Body

{
  "@type": "Conversation",
  "id": "/conversations/JYnJBY",
  "@context": "/contexts/Conversation.jsonld",
  "slug": "JYnJBY",
  "currentState": "closed",
  "account": "/accounts/marks_llc",
  "requestingUserInfo": {
    "@type": "ConversationUserInfo",
    "id": "/conversations/JYnJBY/user_info",
    "@context": "/contexts/ConversationUserInfo.jsonld",
    "read": false,
    "readToTimelinePosition": null,
    "starred": false,
    "assigned": false
  },
  "phoneNumber": "+13035551234",
  "formattedPhoneNumber": "(303) 555-1234",
  "assignedContact": {
    "id": "/contacts/Vled2N",
    "@type": "Contact",
    "@context": "/contexts/Contact.jsonld",
    "name": "Jamel Hirthe",
    "firstName": "Jamel",
    "lastName": "Hirthe",
    "phones": {
      "id": "/contacts/Vled2N/phones",
      "@type": "hydra:Collection",
      "@context": "/contexts/hydra:Collection.jsonld",
      "totalItems": 1,
      "members": [
        {
          "@type": "ContactPhone",
          "id": "/contact_phones/mxvbRw",
          "@context": "/contexts/ContactPhone.jsonld",
          "phoneNumber": "+13035551234",
          "formattedPhoneNumber": "(303) 555-1234",
          "extension": null,
          "type": "Mobile",
          "deliverabilityStatus": "unknown",
          "contact": "/contacts/DQeeO69"
        }
      ]
    },
    "notes": "/contacts/DQeeO69/notes",
    "conversations": "/contacts/DQeeO69/conversations",
    "data": {},
    "customData": {
      "@context": "/contexts/hydra:Collection.jsonld",
      "@type": "hydra:Collection",
      "id": "/contacts/DQeeO69/custom_data",
      "members": [],
      "totalItems": 0
    },
    "createdAt": "2020-01-06T21:49:58.312Z"
  },
  "associatedContacts": "/conversations/JYnJBY/associated_contacts",
  "participants": "/conversations/JYnJBY/participants",
  "assignments": "/conversations/JYnJBY/assignments",
  "reopenConversation": null,
  "closeConversation": "/conversations/JYnJBY/close",
  "readConversation": "/conversations/JYnJBY/read",
  "unreadConversation": "/conversations/JYnJBY/read",
  "starConversation": "/conversations/JYnJBY/star",
  "unstarConversation": "/conversations/JYnJBY/star",
  "blockConversation": "/conversations/Pvwqm5/block",
  "unblockConversation": null,
  "subscribeConversation": null,
  "unsubscribeConversation": "/conversations/Pvwq8zp/subscribe",
  "timeline": "/conversations/JYnJBY/timeline",
  "unanswered": false,
  "unsubscribed": false,
  "blocked": false,
  "stats": "/conversations/Pvwqm5G/stats",
  "assignContact": "/conversations/Pvwqm5G/assign_contact",
  "latestPreviewableItem": {
    "@type": "Message",
    "id": "/messages/06oyogE",
    "@context": "/contexts/Message.jsonld",
    "direction": "in",
    "body": "He once made a weeping willow laugh",
    "formattedBody": "<div>He once made a weeping willow laugh</div>",
    "deliveryState": "received",
    "displayTimestamp": "2018-07-24T20:59:32.156Z",
    "timelinePosition": "2018-07-24T20:59:32.156Z",
    "conversation": "/conversations/JYnJBY",
    "sender": null,
    "attachments": {
      "@context": "/contexts/hydra:Collection.jsonld",
      "@type": "hydra:Collection",
      "id": "/messages/joZqVWd/attachments",
      "members": [],
      "totalItems": 0
    },
    "friendlyStateDescription": "Inbound Message Received",
    "retryAllowed": false,
    "retry": null,
    "latestEventAt": "2018-07-24T20:59:32.156Z",
    "flags": []
  }
}

© 2023 TextUs