Skip to main content
PATCH
Update a contact
Update a single contact identified by contact_id. The fields language, locale, and time_zone may be omitted. If omitted in the API request, the rest of the fields related to permissions will be updated to their default values (which is ‘false’)
We do not currently support PUT. This may be supported in a later release.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token.

X-Contact-ID
string

The identifier of a contact.

Path Parameters

contact_id
string
required

The identifier of a contact.

Query Parameters

client_id
string
required

The identifier of a client.

Body

application/json

List of field names and values for update an existing contact.

The data to update a contact.

can_authorise_payments
boolean

True if contact can authorise payments, False otherwise.

can_make_same_currency_payments
boolean

True if contact can create trades and assign same currency payments, False otherwise.

can_manage_beneficiaries
boolean

True if contact can manage beneficiaries, False otherwise.

can_manage_beneficiaries_groups
boolean

True if can manage beneficiaries groups, False otherwise.

can_manage_contacts
boolean

True if contact can manage contacts, False otherwise.

can_manage_fix_forwards
boolean

True if contact can manage fixed forwards, False otherwise.

can_manage_multipayments
boolean

True if contact can manage multipayments, False otherwise.

can_manage_payments
boolean

True if contact can manage payments, False otherwise.

can_manage_permissions
boolean

True if contact can manage permissions, False otherwise.

can_trade
boolean

True if contact can execute trades, False otherwise.

can_make_independent_payments
boolean

True if contact can make independent payments, False otherwise.

can_drawdown
boolean

True if contact can create drawdowns, False otherwise.

can_get_paid
boolean

True if contact can see/create get paid requests, False otherwise.

can_manage_third_parties
boolean

True if contact can manage third parties, False otherwise.

can_authorize_payment_lvl_1
boolean

True if contact can authorise payments at level 1, False otherwise.

can_authorize_payment_lvl_2
boolean

True if contact can authorise payments at level 2, False otherwise.

can_authorize_payment_lvl_3
boolean

True if contact can authorise payments at level 3, False otherwise.

can_authorize_payment_lvl_4
boolean

True if contact can authorise payments at level 4, False otherwise.

can_trade_finance
boolean

True if contact can access trade finance, False otherwise.

can_select_multipayment_delivery_date
boolean

True if contact can select delivery date in multipayments, False otherwise.

can_manage_trade_finance_permissions
boolean

True if contact can manage trade finance permissions, False otherwise.

can_create_card_topup
boolean

True if contact can create card topup transactions, False otherwise.

can_create_card_offload
boolean

True if contact can create card offload transactions, False otherwise.

has_online_access
boolean

True if contact has access to Ebury Online, False otherwise.

language
string

The ISO 639-1:2002 code of the contact's language.

Pattern: [a-z]{2}
locale
string

The ISO 639-1:2002 code of the contact's locale.

Pattern: [a-z]{2}
time_zone
string

The time zone of the contact.

Response

Contact updated.