VOvopay
Contact Endpoints

contacts/edit

This endpoint is used to add a new contact record for the given account.

post/contacts/edit

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/contacts/edit
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ContactIDstring required

The ID for the contact you wish to edit

EmailAddressstring required

The email address to be associated with this contact

PhoneNumberstring required

The phone number to be associated with this contact

FirstNamestring required

The first name to be associated with this contact

LastNamestring required

The last name to be associated with this contact

Address1string

Contact's address line 1

Citystring

Contact's city

Provincestring

Contact's province specified using two character abbreviations (eg. BC, AB)

Countrystring

Contact's country specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

Nationalitystring

Contact's nationality specified using full country name or ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code.

PostalCodestring

Contact's postal code.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

ContactIDstring required

This ID of the newly created contact

Example response

{
  "Success": true,
  "ContactID": "test_contact_id"
}

Changes

No recorded changes to this operation across all 1 revision of this API.