Sign in
Contacts

Create Contact

Creates a contact. This will also verify the contact's address if you create it using a live API key. To sucessfully create a contact, either a firstName, a companyName, or both are required. You can supply both, but you cannot supply neither.

You have the option to supply the entire address (except for countryCode) via addressLine1, in which case PostGrid will parse it automatically. However, this is not guaranteed to be correct, so we recommend passing along the structured address fields (city, provinceOrState, etc) if you have them.

Note that if you create a contact that has identical information to another contact, this will simply update the description of the existing contact and return it. This avoids creating duplicate contacts.

post/print-mail/v1/contacts

Request body

OR

Response

The request has succeeded and a new resource has been created as a result.

idstring required

A unique ID prefixed with contact_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

Changes

Changed in 2 of the 7 revisions of this API.45

  • 54cf11f8a76f3See the full diff
    • ○

      added the new optional request property oneOf[ContactCreateWithCompanyName]/secret

      new-optional-request-property

    • ○

      added the new optional request property oneOf[ContactCreateWithFirstName]/secret

      new-optional-request-property

    • ○

      added the optional property secret to the response with the 201 status

      response-optional-property-added

  • c8fedcbd705e42See the full diff
    • ●

      added the new internal_server_error enum value to the error/type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new not_found_error enum value to the error/type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new rate_limit_exceeded_error enum value to the error/type response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new validation_error enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • ○

      added subschema #1 subschema #2 to the response body anyOf list for the response status 401

      response-body-any-of-added

    • ○

      removed subschema #1 subschema #2 from the response body anyOf list for the response status 401

      response-body-any-of-removed

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog