Joinotify

Create a contact

POSThttps://api.joinotify.com/contacts

Creates a contact from a phone number or a BSUID. The phone is normalized to E.164 and stored without the +; without a country code, send defaultCountry.

With ?upsert=true, a contact that already exists is updated instead of answering 409 — and then the answer is 200, optIn is ignored and tagIds replaces the tags. Send optIn with the consent evidence to create the contact already able to receive marketing.

An API key limited to some numbers gets 403: this operation covers the whole base.

Query Params

1 optional

stringoptional

Updates the contact when it already exists, instead of answering 409.

Allowed values:true

Body Paramsapplication/json

11 optional

stringoptional

Phone in international format. Without a country code, use defaultCountry.

max. 40 charactersnullable

stringoptional

max. 160 charactersnullable

stringoptional

Country (ISO 3166-1 alpha-2) to read a phone without a country code.

exactly 2 characters

stringoptional

max. 80 charactersnullable

stringoptional

max. 80 charactersnullable

string<email>optional

max. 254 charactersnullable

stringoptional

nullablepattern ^[a-z]{2}(-[A-Z]{2})?$

stringoptional

max. 64 charactersnullable

objectoptional

Patch over the custom fields. null or "" clear the value; the format is validated by the field type.

array of stringsoptional

Tag ids. On an edit, it is the complete set.

up to 50 items

objectoptional

Creation only: records marketing consent at sign-up.

Responses