Update

PUT /contacts/:contact

Update an existing Contact

Examples

Updating the contact with an array of phones

Request

PUT /contacts/DQeeO69

Body

{
  "name": "Cordell Walker",
  "phones": [
    {
      "number": "1-720-333-1234",
      "type": "Mobile"
    },
    {
      "number": "1-720-333-1235",
      "type": "Mobile"
    },
    {
      "number": "1-303-123-4567 x2921",
      "type": "Work"
    }
  ],
  "data": {
    "businessName": "McDonalds",
    "tags": ["cashier", "burger flipper", "fry cook"]
  }
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X PUT /contacts/DQeeO69
    -d '{
  "name": "Cordell Walker",
  "phones": [
    {
      "number": "1-720-333-1234",
      "type": "Mobile"
    },
    {
      "number": "1-720-333-1235",
      "type": "Mobile"
    },
    {
      "number": "1-303-123-4567 x2921",
      "type": "Work"
    }
  ],
  "data": {
    "businessName": "McDonalds",
    "tags": ["cashier", "burger flipper", "fry cook"]
  }
}'

Response

Status

200

Response Type

Contact

Example Body

{
  "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"
      },
      {
        "@type": "ContactPhone",
        "id": "/contact_phones/mxvbRw",
        "@context": "/contexts/ContactPhone.jsonld",
        "phoneNumber": "+13035551234",
        "formattedPhoneNumber": "(303) 555-1234",
        "extension": "2921",
        "type": "Mobile",
        "deliverabilityStatus": "unknown",
        "contact": "/contacts/DQeeO69"
      }
    ]
  },
  "notes": {
    "@type": "hydra:Collection",
    "id": "/contacts/DQeeO69/notes",
    "@context": "/contexts/hydra:Collection.jsonld",
    "totalItems": 0,
    "members": [
      {
        "@type": "ContactNote",
        "id": "/contact_notes/RN5QNG",
        "@context": "/contexts/ContactNote.jsonld",
        "content": "Life is a fragile thing, Har. One minute you're chewin' on a burger, the next minute you're dead meat.",
        "createdAt": "2018-10-31T16:17:10.914Z",
        "updatedAt": "2018-10-31T16:17:10.914Z",
        "user": {
          "@type": "User",
          "@context": "/contexts/User.jsonld",
          "id": "/users/wqyODPA",
          "name": "Chuck Norris",
          "firstName": "Chuck",
          "lastName": "Norris",
          "email": "chuck@textus.example",
          "avatar": null,
          "automatedActor": false,
          "hasPassword": false,
          "discarded": false,
          "settings": {
            "customSettings": {}
          },
          "memberships": "/users/wqyODPA/memberships"
        },
        "contact": "/contacts/DQeeO69"
      }
    ]
  },
  "conversations": "/contacts/DQeeO69/conversations",
  "data": {
    "businessName": "McDonalds",
    "tags": [
      "cashier",
      "burger flipper",
      "fry cook"
    ]
  },
  "createdAt": "2020-01-06T21:49:58.312Z"
}

Updating the contact with a collection of phones

Request

PUT /contacts/DQeeO69

Body

{
  "name": "Cordell Walker",
   "phones": {
     "@type": "hydra:Collection",
     "id": "/contacts/DQeeO69/phones",
     "@context": "/contexts/hydra:Collection.jsonld",
     "totalItems": 3,
     "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"
        }
     ]
   },
  "data": {
    "businessName": "McDonalds",
    "tags": ["cashier", "burger flipper", "fry cook"]
  }
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X PUT /contacts/DQeeO69
    -d '{
  "name": "Cordell Walker",
   "phones": {
     "@type": "hydra:Collection",
     "id": "/contacts/DQeeO69/phones",
     "@context": "/contexts/hydra:Collection.jsonld",
     "totalItems": 3,
     "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"
        }
     ]
   },
  "data": {
    "businessName": "McDonalds",
    "tags": ["cashier", "burger flipper", "fry cook"]
  }
}'

Response

Status

200

Response Type

Contact

Example Body

{
  "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"
      },
      {
        "@type": "ContactPhone",
        "id": "/contact_phones/mxvbRw",
        "@context": "/contexts/ContactPhone.jsonld",
        "phoneNumber": "+13035551234",
        "formattedPhoneNumber": "(303) 555-1234",
        "extension": "2921",
        "type": "Mobile",
        "deliverabilityStatus": "unknown",
        "contact": "/contacts/DQeeO69"
      }
    ]
  },
  "notes": {
    "@type": "hydra:Collection",
    "id": "/contacts/DQeeO69/notes",
    "@context": "/contexts/hydra:Collection.jsonld",
    "totalItems": 0,
    "members": [
      {
        "@type": "ContactNote",
        "id": "/contact_notes/RN5QNG",
        "@context": "/contexts/ContactNote.jsonld",
        "content": "Life is a fragile thing, Har. One minute you're chewin' on a burger, the next minute you're dead meat.",
        "createdAt": "2018-10-31T16:17:10.914Z",
        "updatedAt": "2018-10-31T16:17:10.914Z",
        "user": {
          "@type": "User",
          "@context": "/contexts/User.jsonld",
          "id": "/users/wqyODPA",
          "name": "Chuck Norris",
          "firstName": "Chuck",
          "lastName": "Norris",
          "email": "chuck@textus.example",
          "avatar": null,
          "automatedActor": false,
          "hasPassword": false,
          "discarded": false,
          "settings": {
            "customSettings": {}
          },
          "memberships": "/users/wqyODPA/memberships"
        },
        "contact": "/contacts/DQeeO69"
      }
    ]
  },
  "conversations": "/contacts/DQeeO69/conversations",
  "data": {
    "businessName": "McDonalds",
    "tags": [
      "cashier",
      "burger flipper",
      "fry cook"
    ]
  },
  "createdAt": "2020-01-06T21:49:58.312Z"
}

Updating the contact with an external ID for an integration

Request

PUT /contacts/DQeeO69

Body

{
  "data": {
    "workday": {
      "Candidate": {
        "Candidate_Data": {
          "Candidate_ID": "abc123"
        }
      }
    }
  }
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X PUT /contacts/DQeeO69
    -d '{
  "data": {
    "workday": {
      "Candidate": {
        "Candidate_Data": {
          "Candidate_ID": "abc123"
        }
      }
    }
  }
}'

Response

Status

200

Response Type

Contact

Example Body

{
  "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": {
    "@type": "hydra:Collection",
    "id": "/contacts/DQeeO69/notes",
    "@context": "/contexts/hydra:Collection.jsonld",
    "totalItems": 0,
    "members": []
  },
  "conversations": "/contacts/DQeeO69/conversations",
  "data": {
    "workday": {
      "Candidate": {
        "Candidate_Data": {
          "Candidate_ID": "abc123"
        }
      }
    }
  },
  "createdAt": "2020-01-06T21:49:58.312Z"
}

© 2024 TextUs