Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Contact object: This is the only mandatory object. You need to provide at least the email and the first name of the contact to be able to create a lead.

  • Phone object: If one of the two phone fields are missing the phone is not going to be created.

    • Country: Must be in 2 character format.

    • Number: Can be in international format, at least the 10 phone digits with no special characters are needed. Examples of valid phones:

      • +15124713434

      • 5124713434

  • Billing/Shipping address: For creating an address all of its fields except the line2 are required.

    • Country: Must be in 2 character format.

    • State: Must be in 2 character format.

    • City: Maximum 100 characters length.

    • Line: Maximum 255 characters length.

    • Line2: Maximum 255 characters length.

    • Zip code: Maximum length of 20 characters. Ensure the zip code format matches your country's requirements (e.g., 5 digits for the US).

  • Order: Another optional field, if provided it will generate an order note within you contact profile.

    • Id: The id of your order in your external platform.

    • Type. The status type of the order. For example: failed, success, refund. There is no a specific set of values here, just provide the one in your external platform.

    • Date: When the order was created in your external platform. It must be provided in the format Y-m-d H:i:s. See example payload.

    • Subtotal: Optional.

    • Shipping: Optional..

    • Tax: Optional.

    • Total: The only needed amount field in the order.

    • Items: Optional array, but when provided must have this structure.

      • Title: Item’s product name. Every item name will be used to generate a tag for the contact.

      • Quantity: Item’s quantity sold.

      • Total: Item’s amount charged.

  • Additional tags: Array of tags to be also attached to the contact.

...