Contact Fields
Updating standard field contact values
update route
PUT: /fields/standardField/:fieldName
Possible Field Names
:fieldName | Field Value Type | Description |
---|---|---|
discordUsername | string | The discord username for unauthenticated Discord contacts. |
twitterUsername | string | The twitter username for unauthenticated Twitter contacts. |
string | The contact's email. | |
phoneNumber | string | The contacts phone number stored as a string. i.e. '+13175551234' |
birthday | int | The contacts birthday stored as an Epoch timestamp. |
Body Structure
FIELD | TYPE | Description |
---|---|---|
contactId | string | Id of the contact. |
value | Updated value of the field being updated . |
Return
CODE | RETURN |
---|---|
201 | Updated Value |
400 | Field Error |
500 | Neo4j Error |
Updating custom field contact values
update route
PUT: /fields/customField/:customFieldId
Body
FIELD | TYPE | Description |
---|---|---|
contactId | string | Id of the contact. |
value | any | Updated value of the field being updated. |
Return
CODE | RETURN |
---|---|
201 | Updated Value |
403 | Cannot Edit Readonly fields |
404 | Custom Field not Found |
500 | Neo4j Error |
Last updated