Change log

CRM Contact API

Retrieve a CRM member via member token as well as Update member password.

GET CRM Contact by Token

Retrieves a CRM contact as a JSON response from the given token.

/api/v2/frontend/contacts/by-token

Data / Response:

{
    "CRMMemberToken": ""
}

{
  "Id": 0,
  "Email": "string",
  "FirstName": "string",
  "LastName": "string",
  "CrmType": "Contact",
  "EmailConfirmed": true,
  "Role": "General",
  "CreatedDate": "2024-05-22T17:17:45.552Z",
  "Address": "string",
  "City": "string",
  "State": "string",
  "ZipCode": "string",
  "Country": "string",
  "Site": "string",
  "Phone": "string",
  "Status": "string",
  "Notes": "string",
  "Type": 0,
  "CustomerTypeName": "string",
  "IsDataUsingAllowed": true,
  "CustomCrmGroups": {
    "<GroupAlias1>": {
      "<FieldAlias1>": "<value>",
      "<FieldAlias2>": false,
      "<FieldAlias3>": 0
    }
  }
}

PUT CRM Contact Password Update

Updates a CRM contact's password from the current password.

/api/v2/frontend/contacts/update-password

Data / Response:

{
  "Password": "string",
  "ConfirmPassword": "string",
  "OldPassword": "string",
  "CRMMemberToken": "string"
}

Status 204
Validation:
  1. When UserToken is empty
    • Error message: UserToken is required
  2. When UserToken is expired
    • Error message: UserToken is expired
  3. When UserToken is not found in the database
    • Error message: UserToken is invalid

External Resources

There are currently no external resources available.

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.

Questions?

We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.