Skip to main content
POST
/
api
/
v1
/
customers
/
{id}
/
sync
Sync customer data
curl --request POST \
  --url https://payments.oaknetwork.org/api/v1/customers/{id}/sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "providers": [
    "stripe"
  ],
  "fields": [
    "email",
    "phone"
  ]
}
'
{
  "msg": "Sync scheduled",
  "data": null
}

Authorizations

​
Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
providers
string[]
required

Single provider name to sync with

Required array length: 1 element
​
fields
string[]
required

Fields to sync (from syncable fields list)

Minimum array length: 1

Response

Sync scheduled

​
msg
string
required

Human-readable message describing the result

​
data
any
required

Response payload (null on error)