📖Contact Management

Basic CRUD operations on Contact Management. These are specific individual contacts associated with a Merchant Account.

List Contacts

Use this endpoint to list all contacts associated with a merchant account.

get

Query parameters

pageintegerOptional

Page number (default: 0)

page_sizeinteger · min: 1 · max: 10Optional

Number of results per page (default: 10)

Header parameters

AuthorizationstringRequired

Secret Token for user authentication

Example: {"value":"Token tk-1234sOuTH-AfrICa567"}

Responses

200

paginated list of contacts

application/json

400

invalid data

application/json

404

not found

application/json

get

/api/v1/contacts

HTTPcURLJavaScriptPython

GET /api/v1/contacts HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Accept: */*

{
  "count": 19,
  "nextUrl": "http://api.digimali.co.za/api/v1/contacts/?page=4&page_size=2",
  "previousUrl": "http://api.digimali.co.za/api/v1/contacts/?page=2&page_size=2",
  "results": [
    {
      "email": "[email protected]",
      "first_name": "Jon",
      "id": 3456,
      "last_name": "Doe",
      "phone": "[phone]",
      "role": "VP Engineering"
    },
    {
      "email": "[email protected]",
      "first_name": "Jane",
      "id": 4567,
      "last_name": "Smith",
      "phone": "[phone]",
      "role": "CTO"
    }
  ]
}

Get Contact

Use this endpoint to get a specific contact, provide contact ID.

get

Path parameters

contact_idintegerRequired

ID of the additional contact to fetch

Header parameters

AuthorizationstringRequired

Secret Token for user authentication

Example: {"value":"Token tk-1234sOuTH-AfrICa567"}

Responses

200

contact updated successfully

application/json

Responseall of

400

invalid data

application/json

404

not found

application/json

get

/api/v1/contacts/{contact_id}

HTTPcURLJavaScriptPython

GET /api/v1/contacts/{contact_id} HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Accept: */*

{
  "first_name": "Jon",
  "last_name": "Doe",
  "phone": "[phone]",
  "role": "VP Engineering",
  "email": "[email protected]",
  "id": 3456
}

Create a Contact

Use this endpoint to create a new contact.

post

Header parameters

AuthorizationstringRequired

Secret Token for user authentication

Example: {"value":"Token tk-1234sOuTH-AfrICa567"}

Body

application/json

anyOptional

Responses

200

contact created successfully

application/json

Responseall of

400

invalid data

application/json

post

/api/v1/contacts

HTTPcURLJavaScriptPython

POST /api/v1/contacts HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "first_name": "Jon",
  "last_name": "Doe",
  "phone": "[phone]",
  "role": "VP Engineering",
  "email": "[email protected]"
}

{
  "first_name": "Jon",
  "last_name": "Doe",
  "phone": "[phone]",
  "role": "VP Engineering",
  "email": "[email protected]",
  "id": 3456
}

Update a Contact

Use this endpoint to update a contact, given the ID.

post

Path parameters

contact_idintegerRequired

ID of the additional contact to update

Header parameters

AuthorizationstringRequired

Secret Token for user authentication

Example: {"value":"Token tk-1234sOuTH-AfrICa567"}

Body

application/json

first_namestringOptionalExample: Jon

last_namestringOptionalExample: Doe

phonestringOptionalExample: [phone]

rolestringOptionalExample: VP Engineering

Responses

200

contact updated successfully

application/json

Responseall of

400

invalid data

application/json

404

not found

application/json

post

/api/v1/contacts/{contact_id}

HTTPcURLJavaScriptPython

POST /api/v1/contacts/{contact_id} HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "first_name": "Jon",
  "last_name": "Doe",
  "phone": "[phone]",
  "role": "VP Engineering"
}

{
  "first_name": "Jon",
  "last_name": "Doe",
  "phone": "[phone]",
  "role": "VP Engineering",
  "email": "[email protected]",
  "id": 3456
}

Delete a Contact

Use this endpoint to delete a contact, given the ID.

delete

Path parameters

contact_idintegerRequired

ID of the additional contact to delete

Header parameters

AuthorizationstringRequired

Secret Token for user authentication

Example: {"value":"Token tk-1234sOuTH-AfrICa567"}

Responses

200

contact updated successfully

application/json

400

invalid data

application/json

404

not found

application/json

delete

/api/v1/contacts/{contact_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/contacts/{contact_id} HTTP/1.1
Host: stage-api.digimali.co.za
Authorization: text
Accept: */*

{
  "message": "additional contact has been deleted successfully"
}