Textline API

Update a Customer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://reference.textline.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Textline API MCP server": {
    "url": "https://reference.textline.com/mcp"
  }
}
Close
PUT /api/customer/{uuid}.json

Update a record in the address book. To include custom fields and their values, add the custom_fields object and use the custom field's uuid (found here) and the value you want to set within the object.

Path parameters

  • uuid string Required

    Identifier of the Customer to perform action with.

application/json

Body

  • customer object
    Hide customer attributes Show customer attributes object
    • email string
    • name string
    • notes string
    • tags string

      A comma or space separated list of customer tags. Use underscores for tags that you want to space out.

    • tags_handling string

      A way to tell Textline how to process the values in Tags. Valid options are: add, remove, and replace.

    • archived boolean

      Remove the contact's messages from the conversation dashboard and prevent users from sending them Announcements and Surveys. You may search for the contact specifically to see their messages.

    • blocked boolean

      Prevent a contact's messages by being seen in the conversation dashboard. You may search for the contact specifically to see their messages.

    • unreachable boolean

      Should the customer be unsubscribed so that you do not message them at all.

    • custom_fields object
      Hide custom_fields attributes Show custom_fields attributes object
      • c43a1766-47e1-4c9c-a2cc-36bf424fcbc0 string

        To update custom field for a customer, you must first get the custom field's UUID and use that to repace field_uuid

      • 342fbe5b-da20-4f82-b899-53f4a5b0a8df string

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • customer object
      Hide customer attributes Show customer attributes object
      • avatar_url string | null
      • blocked boolean

        Has this customer has been blocked from sending you messages

      • archived boolean

        Has this customer been archived in your address book

      • name string | null
      • notes string | null
      • phone_number string | null
      • reachable_by_sms boolean

        Is this customer capable of receiving sms

      • tags array
      • uuid string
      • facebook_id string | null
      • custom_fields object

        This is a list of the custom fields created in the account by their uuid and the values for this contact.

        Hide custom_fields attributes Show custom_fields attributes object
        • c43a1766-47e1-4c9c-a2cc-36bf424fcbc0 string
        • 116bad5a-6233-472d-bcf0-199d53342a82 string
      • consent_status boolean

        Has this customer given consent to be messaged. A feature of HIPAA and pro plan accounts. Values of true, false, and null, with null representing no request has been made.

      • verified boolean

        This pertains to webchat and whether a contact has gone through the sync process for the conversation.
PUT /api/customer/{uuid}.json 
curl \
 --request PUT 'https://application.textline.com/api/customer/84a2c56f-6b79-4764-811d-90880e2757b4.json' \
 --header "Content-Type: application/json" \
 --data '{
  "customer": {
    "email": "chuck@mycompany.com",
    "name": "Chuck Finley",
    "notes": "some samples notes for the contact",
    "tags": "foo_bar",
    "tags_handling": "replace",
    "archived": false,
    "blocked": false,
    "unreachable": false,
    "custom_fields": {
      "c43a1766-47e1-4c9c-a2cc-36bf424fcbc0": "custom field 1 value",
      "342fbe5b-da20-4f82-b899-53f4a5b0a8df": "custom field 2 value"
    }
  }
}'
Request example 
{
  "customer": {
    "email": "chuck@mycompany.com",
    "name": "Chuck Finley",
    "notes": "some samples notes for the contact",
    "tags": "foo_bar",
    "tags_handling": "replace",
    "archived": false,
    "blocked": false,
    "unreachable": false,
    "custom_fields": {
      "c43a1766-47e1-4c9c-a2cc-36bf424fcbc0": "custom field 1 value",
      "342fbe5b-da20-4f82-b899-53f4a5b0a8df": "custom field 2 value"
    }
  }
}
Response examples (200) 
{
  "customer": {
    "avatar_url": "https://example.com/image.png",
    "blocked": false,
    "archived": false,
    "name": "Chuck Finley",
    "notes": "``",
    "phone_number": "(222) 222-2222",
    "reachable_by_sms": true,
    "tags": [
      "foo",
      "bar"
    ],
    "uuid": "deb79a6a-0652-4e14-86f2-dc8c5c502369",
    "facebook_id": "null",
    "custom_fields": {
      "c43a1766-47e1-4c9c-a2cc-36bf424fcbc0": "Custom_Field_1_value",
      "116bad5a-6233-472d-bcf0-199d53342a82": "null"
    },
    "consent_status": true,
    "verified": true
  }
}