Addresses

Creates a new address for a specific user

post
Authorizations
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
200Success
application/json
post
POST /v1/crm/addresses HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "params": {
    "userId": "text",
    "id": "text",
    "building": "text",
    "street": "text",
    "secondary": "text",
    "district": "text",
    "postalCode": "text",
    "city": "text",
    "country": "text",
    "instructions": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true,
    "uid": "text"
  }
}

Deletes an address.

delete
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
200Success
application/json
delete
DELETE /v1/crm/addresses/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates a new address for a specific user

patch
Authorizations
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
200Success
application/json
patch
PATCH /v1/crm/addresses/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "params": {
    "uid": "text",
    "building": "text",
    "street": "text",
    "secondary": "text",
    "district": "text",
    "postalCode": "text",
    "city": "text",
    "country": "text",
    "instructions": "text"
  }
}
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Was this helpful?