Create Contact

POST 
https://embedded.runalloy.com/2024-03/one/crm/contacts

Create contact

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

application/json

Body

lastName stringrequired

The last name or surname of the contact.

firstName string

The first name of the contact.

account string

The name or identifier of the account with which the contact is associated.

addresses

object[]

An array of address objects related to the contact.

Array [

addressType string

The type of the address (e.g., shipping, billing).

street1 string

The first line of the address.

street2 string

The second line of the address.

city string

The city of the address.

state string

The state of the address.

countrySubdivision string

The country subdivision of the address.

country string

The country of the address.

postalCode string

The postal/zip code of the address.

]

emailAddresses

object[]

An array of email address objects associated with the contact.

Array [

emailAddressType string

The type of the email address (e.g., main, secondary).

emailAddress string

The email address.

]

phoneNumbers

object[]

An array of phone number objects associated with the contact.

Array [

phoneNumberType string

The type of the phone number (e.g., primary, secondary).

phoneNumber string

The phone number.

]

remoteFields json

An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses

200

200

application/json

Schema

Schema

contact

object

remoteId string

firstName string

lastName string

account

addresses

object[]

Array [

addressType string

]

emailAddresses array

phoneNumbers array

lastActivityAt string

id string

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "contact": {
    "remoteId": "151",
    "firstName": "Brandon",
    "lastName": "Looker",
    "account": {},
    "addresses": [
      {
        "addressType": "main"
      }
    ],
    "emailAddresses": [
      null
    ],
    "phoneNumbers": [
      null
    ],
    "lastActivityAt": "2023-10-27T14:42:44.054Z",
    "id": "4b5cc100-b204-44fa-74df-109e233541a8",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

Result

{
  "contact": {
    "remoteId": "151",
    "firstName": "Brandon",
    "lastName": "Looker",
    "account": null,
    "addresses": [
      {
        "addressType": "main"
      }
    ],
    "emailAddresses": [],
    "phoneNumbers": [],
    "lastActivityAt": "2023-10-27T14:42:44.054Z",
    "id": "4b5cc100-b204-44fa-74df-109e233541a8",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://embedded.runalloy.com/2024-03/one/crm/contacts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "lastName": "string",
  "firstName": "string",
  "account": "string",
  "addresses": [
    {
      "addressType": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "countrySubdivision": "string",
      "country": "string",
      "postalCode": "string"
    }
  ],
  "emailAddresses": [
    {
      "emailAddressType": "string",
      "emailAddress": "string"
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumberType": "string",
      "phoneNumber": "string"
    }
  ],
  "remoteFields": "string"
}'

Request Collapse all

Base URL

https://embedded.runalloy.com/2024-03/one

Parameters

credentialId — queryrequired

Authorization — headerrequired

Body

{
  "lastName": "string",
  "firstName": "string",
  "account": "string",
  "addresses": [
    {
      "addressType": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "countrySubdivision": "string",
      "country": "string",
      "postalCode": "string"
    }
  ],
  "emailAddresses": [
    {
      "emailAddressType": "string",
      "emailAddress": "string"
    }
  ],
  "phoneNumbers": [
    {
      "phoneNumberType": "string",
      "phoneNumber": "string"
    }
  ],
  "remoteFields": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!