POST
/
curl --request POST \
  --url https://updatecontactlist.api.velt.dev/
{
  "result": {
    "status": "success",
    "message": "Contact list updated successfully.",
    "data": null
  }
}

Create or Replace Contact List for a Group ID using POST Method API

User's within the same groupId will see the same contacts list.

You can use this method to create a new contact list for an entire groupId if you don’t already have a groupId contact list set up yet.

You can also use this method to replace an entire groupId's contact list if you already have an existing list and want to replace it.

This is useful if you have your user data maintained in a separate database and want to sync the contacts list with your database.

On the client side, be sure to use the same groupId when authenticating your Users. Otherwise, they will not see the correct contact list.

Endpoint:

https://updatecontactlist.api.velt.dev

Not sure where find your Auth Token? You can follow these steps to generate your Auth Token.

Body:

{
  "data": {
    "apiKey": "YOUR_API_KEY",
    "groupId": "GROUPID", // no hyphens or special characters allowed
    "authToken": "YOUR_AUTH_TOKEN", 
    "contacts": [
      {
        "email": "contact1@gmail.com",
        "name": "Contact 1",
        "photoUrl": "https://snippyly.com/assets/avatars/avatar-tiger.svg",
        "userId": "123"
      },
      {
        "email": "contact2@gmail.com",
        "name": "Contact 2",
        "photoUrl": "https://w7.pngwing.com/pngs/656/85/png-transparent-yellow-circles-background-other-orange-computer-wallpaper.png",
        "userId": "1234"
      },
      {
        "email": "contact3@gmail.com",
        "name": "Contact 3",
        "photoUrl": "https://snippyly.com/assets/avatars/avatar-tiger.svg",
        "userId": "12345"
      }
    ]
  }
}

No special characters such as dashes are allowed in groupId

Success Response:

{
  "result": {
    "status": "success",
    "message": "Contact list updated successfully.",
    "data": null
  }
}

Failure Response:

{
  "error": {
    "message": "Invalid Api key!",
    "status": "UNAUTHENTICATED"
  }
}
result
object

Response result

message
string

Status description message for the response

status
string

Status for the response

data
object

Contains data for the response