Update Agent
PUT/agents/:id
Update Agent
Request
Path Parameters
- application/json
Body
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Type
Name
Phone
First Name
Last Name
Nickname
Gender
Possible values: [Male, Female, Other]
Date of Birth
Tags
Address 1
Address 2
Address 3
City
State
Postal Code
Country
addresses
object[]
Agent
Type
Is Primary
Name
Organization
Address1
Address2
Address3
City
Region
Postal Code
Country
Phone Number
Notes
Tags
contactMethods
object[]
Agent
Type
Possible values: [Email, Phone, Fax, SMS, Social Media, Other]
Name- Add a name for this contact method
Value
Priority
Preferences
Notes- Any instructions or preferences for this contact method.
Confirmed
Tags
documents
object[]
Agent
Tags
Type
Name
File Name
Notes
Visibility
notes
object[]
Agent
Note
Tags
preferences
object[]
Agent
Key
Value
Strict
Notes
Tags
Responses
- 200
Updated Agent
- application/json
- Schema
- Example (from schema)
Schema
Type
Name
Phone
First Name
Last Name
Nickname
Gender
Possible values: [Male, Female, Other]
Date of Birth
Tags
Address 1
Address 2
Address 3
City
State
Postal Code
Country
Last Active
Id
Created At
Updated At
Deleted At
Deleted
Created By
Updated By
Deleted By
Status
Age
Full Name
ID
{
"type": "string",
"name": "string",
"primaryEmail": "string",
"primaryPhone": "string",
"firstName": "string",
"lastName": "string",
"nickname": "string",
"gender": "Male",
"dateOfBirth": "string",
"tags": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string",
"lastActive": "string",
"id": "string",
"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"deleted": "string",
"createdBy": "string",
"updatedBy": "string",
"deletedBy": "string",
"status": "string",
"age": 0,
"fullName": "string",
"clientId": "string"
}