Contact – Create
contact_createAdds a contact. If the user already has this person, the values may go to that contact instead:
If the user's Auto-Merge level covers the match, the values are added to the existing contact: 200,
merged.Otherwise a new contact is created: 201,
created. If it may be a duplicate, it also waits in Review duplicates: 201,needs_review.
ContactZapp saves the contact in one two-way account: the first one the user linked that keeps an address book and is not paused. The next sync copies it to the user's other two-way accounts, never to a read-only one.
A create is never refused for the plan's contact limit. Over the limit, the contact is created frozen and contact.frozen is true. ContactZapp keeps a frozen contact but does not sync it until the user upgrades or frees a place.
Send an Idempotency-Key header to make a retry safe.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The body of a contact create or update: the contact fields a read shows that a write can change, under the same names and in the same shapes, and nothing else. A field the body carries that is not one of them is refused with a 400 `unknown_field`, and nothing is written. That includes the read-only `id`, `publicId`, `displayName` and `updatedAt`, so writing back a whole contact as a read returned it answers 400 `unknown_field`: send only the fields you change. A create writes the fields the body carries. An update is change-only: a field the body does not carry keeps its value, a field it carries empty (`""`, `[]`, or a date whose year, month and day are all `0`) is cleared, and a list it carries replaces the stored list. `"birthday": null` clears the birthday too, and a birthday the body does not carry is kept. Fields ContactZapp keeps that a read does not show are never changed by an update. | |
| Idempotency-Key | No | Any string of 1 to 255 bytes you choose for this write, such as a UUID. Repeat the request with the same key and body within 24 hours, and you get the first result back and nothing is written twice. The same key with a different body is a 422. |